doxme
doxme是什么
什么是doxme,create markdown docs for dox output
doxme使用教程帮助文档
future work on documentation is going to be in the documentation project instead of on doxme: documentation will have a higher level of configurability and compleness than doxme.
doxme
create markdown docs for dox output
doxme(dox, readme, package, travis)
A Markdown formatter for dox. Takes dox’s JSON output as stdin and writes Markdown to stdout.
- Generates API documentation as well as entire READMEs (like this one!)
- README generation supports Travis-CI badges
CLI Usage
dox -r < index.js | doxme
The doxme
bin supports one important option: --readme
. When provided, it generates a full README.md file, including title, description, installation and test instructions, and a Travis-CI badge if the project is tested with travis.
dox -r < index.js | doxme --readme > README.md
See Also
- gulp-doxme runs doxme within a Gulp pipeline
Parameters
parameter | type | description |
---|---|---|
dox |
Object | the output of dox as a parsed JSON object |
readme |
boolean | whether to output a readme or just docs |
package |
Object | a parsed package.json |
travis |
boolean | whether to output a travis badge along with docs |
Example
var fs = require('fs');
var dox = require('dox');
var doxme = require('doxme');
var sourceCode = fs.readFileSync('./index.js', 'utf8');
var documentation = doxme(dox.parseComments(sourceCode));
Returns String
, documentation
Installation
Requires nodejs.
$ npm install doxme
Tests
$ npm test
本站文章除注明转载外,均为本站原创或编译。欢迎任何形式的转载,但请务必注明出处。
转载请注明:文章转载自 JavaScript中文网 [https://www.javascriptcn.com]
本文地址:https://www.javascriptcn.com/read-40319.html
文章标题:doxme