documentation-wrapper

documentationjs wrapper command line tool.

Why?

• documentationjs not allow to customize output of build -f md or readme.
• documentation-wrapper replace documentationjs's internal markdown template with simple-markdown-ast.js

Install

Install with npm:

npm install -g documentation-wrapper

Usage

Same with documentationjs

documentation-wrapper build -f md lib/markdown/simple-markdown-ast.js

Example Output

commentsToAST(comments: Array<Object>, opts: Object, callback: Function): undefined

Given a hierarchy-nested set of comments, generate an remark-compatible Abstract Syntax Tree usable for generating Markdown output

Parameters

• comments: Array<Object> - nested comment
• opts: Object - currently none accepted
• callback: Function - called with AST

Returns: undefined

Person

constructor({ name })

Parameters

• name: string - Person name

getName(): string

get person name

Returns: string

hello(text: string): string

Parameters

• text: string

Returns: string - echo text

hello_destructuring({ name, age })

hello with destructuring params

Parameters

• name: string
• age: number

Changelog

See Releases page.

Running tests

Install devDependencies and Run npm test:

npm i -d && npm test

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request :D

Author

• github/azu
• twitter/azu_re

License

MIT © azu