thought-plugin-jsdoc
Add jsdoc to your Thought-generated README.md
Installation
npm install thought-plugin-jsdoc
Usage
In order to use this plugin for thought, first add it to the dev-dependencies of your project
npm install --save-dev thought-plugin-jsdoc
You can then add a file .thought/config.js
to your
project, with the following contents.
moduleexports = plugins:
Thought will then add the jsdoc-comments of your main-file to the README.md
You can see this in the example-project
Configuration
This plugin applies the following configuration
Partials
api.md.hbs
{{#if package.main}}# API reference {{{jsdoc package.main}}}{{/if}}
Helpers
string
jsdoc(globPattern) ⇒ Uses jsdoc-to-markdown
to render jsdoc for files matching a given glob pattern
Kind: global function
Returns: string
- the generated API reference as markdown
Api: public
Param | Type | Description |
---|---|---|
globPattern | string |
a glob-pattern to identify the files to generate docs from |
API reference
License
thought-plugin-jsdoc
is published under the MIT-license.
See LICENSE.md for details.
Release-Notes
For release notes, see CHANGELOG.md
Contributing guidelines
See CONTRIBUTING.md.