Jsdoc to Markdown

Install

npm install @conflux-lib/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('@conflux-lib/jsdoc-to-md')
> const string = jsdocToMd('./src')

Example

see