documentation-markdown-api-theme

documentation's theme for outputing 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

Real Usage

We want to create updatable API Usage to README.md

Install devDependencies:

npm install documentation-markdown-api-theme documentation add-text-to-markdown -D

Add npm run-script for updating ## Usage section

  ...
  "scripts": {
    "docs": "documentation build --access public --theme ./node_modules/documentation-markdown-api-theme/lib/index -f html -o out.md src/index.js && cat out.md | add-text-to-markdown README.md --section \"Usage\" --write; rm out.md",
    "prepublish": "npm run --if-present build && npm run docs"
  },
  "devDependencies": {
    "add-text-to-markdown": "^1.0.3",
    "documentation": "^4.0.0-beta11",
    "documentation-markdown-api-theme": "^1.0.2"
  },
  ...

Update ## Usage section

npm run docs

Why using -f html

See documentationjs/documentation#550

Real Example

See

• https://almin.js.org/docs/api/
• azu/ui-event-observer: Provide performant way to subscribe to browser UI Events.

Example Output

hello_destructuring({ name, age })

hello with destructuring params

Parameters

• name: string
• age: number

hello(text: string): string

Parameters

• text: string

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

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

Returns: undefined

Person

Person class

constructor({ name })

Parameters

• name: string - Person name

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

• github/azu
• twitter/azu_re

License

MIT © azu