@geekberry/jsdoc-to-md
# Install `npm install @geekberry/jsdoc-to-md`
Last updated 2 months ago by geekberry .
MIT · Repository · Original npm · Tarball · package.json
$ cnpm install @geekberry/jsdoc-to-md 
SYNC missed versions from official npm registry.

Jsdoc to Markdown

Install

npm install @geekberry/jsdoc-to-md

Document

jsdocToMd

Generate directory markdown string.

  • Parameters
Name Type Required Default Description
path string true - Filename or directory path
options object false
options.content boolean false true Generate content.
options.filter function false ()=>true Filename filter/
  • Returns

string Markdown string

  • Examples
> const jsdocToMd = require('@geekberry/jsdoc-to-md')
> const string = jsdocToMd('./src')

Example

see

Current Tags

  • 0.0.8                                ...           latest (2 months ago)

8 Versions

  • 0.0.8                                ...           2 months ago
  • 0.0.7                                ...           2 months ago
  • 0.0.6                                ...           3 months ago
  • 0.0.5                                ...           5 months ago
  • 0.0.4                                ...           5 months ago
  • 0.0.3                                ...           9 months ago
  • 0.0.2                                ...           9 months ago
  • 0.0.1                                ...           9 months ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 9
Last Day 0
Last Week 0
Last Month 23
Dependencies (3)
Dev Dependencies (0)
None
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |