1.0.2 • Published 7 years ago
@studyportals/jsdoc-to-markdown v1.0.2
@studyportals/jsdoc-to-markdown@v1.0.2
Generate README.md
based on package.json and corresponding *.js
files.
@studyportals/jsdoc-to-markdown
Example
In the "scripts"
section of package.json
, add a docs
task. For example:
{
"scripts": {
"docs": "jsdoc2md"
}
}
Now, project documentation is generated like so:
$ npm run docs
In node:
const JsdocToMarkdown = require('@studyportals/jsdoc-to-markdown');
JsdocToMarkdown();
JsdocToMarkdown() ⇒ Date ⏏
These properties from the package.json are used to build the documentation:
- name
- version
- repository
- description
- main
- directories.lib
Kind: Exported function
Returns: Date - The date when README.md is generated.
README.md generated at: Wed Jun 28 2017 13:09:47 GMT+0800 (China Standard Time)