README.md

docdown ^v0.7.3

docdown

• docdown

docdown

docdown(options)

[Ⓢ](https://github.com/jdalton/docdown/blob/0.7.3/index.js#L26 "View in source") [Ⓣ][1]

Generates Markdown documentation based on JSDoc comments.

Arguments

1. options (Object): The options object.
2. options.path (string): The input file path.
3. options.url (string): The source URL.
4. [options.lang='js'] (string): The language indicator for code blocks.
5. [options.sort=true] (boolean): Specify whether entries are sorted.
6. [options.style='default'] (string): The hash style for links *('default' or 'github')*.
7. [options.title='<%] (string): The documentation title.
8. [options.toc='properties'] (string): The table of contents organization style *('categories' or 'properties')*.

Returns

(string): The generated Markdown code.

---