documentation-markdown-api-theme

1.0.2 • Public • Published

documentation-markdown-api-theme

documentation's theme that output markdown.

Install

Install with npm:

npm install documentation-markdown-api-theme

Usage

Convert example.js to Markdown API reference

$ documentation build --access public --theme documentation-markdown-api-theme -f html -o out.md example.js

Simulate documentation readme command using add-text-to-markdown:

npm i -g add-text-to-markdown
documentation build --access public --theme documentation-markdown-api-theme -f html -o out.md example.js
echo out.md | add-text-to-markdown path/to/file.md --section "section name" --write

Why using -f html

See https://github.com/documentationjs/documentation/issues/550

Example Output

hello_destructuring({ name, age })

hello with destructuring params

Parameters

hello(text: string): string

Parameters

Returns: string - echo text

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

Returns: undefined

Person

Person class

constructor({ name })

Parameters

getName(): string

get person name

Returns: string

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

License

MIT © azu

Readme

Keywords

Package Sidebar

Install

npm i documentation-markdown-api-theme

Weekly Downloads

19

Version

1.0.2

License

MIT

Last publish

Collaborators

  • azu