UNPKG

jsdoc-to-markdown

Version:

Generates markdown API documentation from jsdoc annotated source code

github.com/jsdoc2md/jsdoc-to-markdown

jsdoc2md/jsdoc-to-markdown

62 lines (42 loc) • 2.07 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
[![view on npm](https://badgen.net/npm/v/jsdoc-to-markdown)](https://www.npmjs.org/package/jsdoc-to-markdown) [![npm module downloads](https://badgen.net/npm/dt/jsdoc-to-markdown)](https://www.npmjs.org/package/jsdoc-to-markdown) [![Gihub repo dependents](https://badgen.net/github/dependents-repo/jsdoc2md/jsdoc-to-markdown)](https://github.com/jsdoc2md/jsdoc-to-markdown/network/dependents?dependent_type=REPOSITORY) [![Gihub package dependents](https://badgen.net/github/dependents-pkg/jsdoc2md/jsdoc-to-markdown)](https://github.com/jsdoc2md/jsdoc-to-markdown/network/dependents?dependent_type=PACKAGE) [![Node.js CI](https://github.com/jsdoc2md/jsdoc-to-markdown/actions/workflows/node.js.yml/badge.svg)](https://github.com/jsdoc2md/jsdoc-to-markdown/actions/workflows/node.js.yml) _Upgraders, please read the [release notes](https://github.com/jsdoc2md/jsdoc-to-markdown/releases)_ # jsdoc-to-markdown Generates markdown API documentation from [jsdoc](https://jsdoc.app) annotated source code. Useful for injecting API docs into project README files. ## Synopsis 1\. Document your code using valid jsdoc comments. ```js /** * A quite wonderful function. * @param {object} - Privacy gown * @param {object} - Security * @returns {survival} */ function protection (cloak, dagger) {} ``` 2\. Run a command. ```sh $ jsdoc2md example.js ``` 3\. Get markdown output. ```markdown ## protection(cloak, dagger) ⇒ <code>survival</code> A quite wonderful function. **Kind**: global function | Param | Type | Description | | ------ | ------------------- | ------------ | | cloak | <code>object</code> | Privacy gown | | dagger | <code>object</code> | Security | ``` ## Install ``` $ npm install --save-dev jsdoc-to-markdown ``` ## See also * [API documentation](https://github.com/jsdoc2md/jsdoc-to-markdown/blob/master/docs/API.md) * The [wiki](https://github.com/jsdoc2md/jsdoc-to-markdown/wiki) for example output, FAQs, tutorials, plugins, use with gulp/grunt etc. * * * &copy; 2014-25 Lloyd Brookes \<opensource@75lb.com\>.