dmd

The default output template for jsdoc-to-markdown

MIT 127 个版本
安装
npm install dmd
yarn add dmd
pnpm add dmd
bun add dmd
README

view on npm npm module downloads Gihub repo dependents Gihub package dependents Node.js CI js-standard-style

dmd

dmd (document with markdown) is the default output template for jsdoc-to-markdown. It contains handlebars partials and helpers intended to transform jsdoc-parse output into markdown API documentation.

For more documentation see the jsdoc2md wiki.

Synopsis

To give the most basic example, this input data:

const templateData = [
  {
    id: "fatUse",
    name: "fatUse",
    kind: "member",
    description: "I am a global variable",
    scope: "global"
  }
]

run through this command:

const dmd = require('dmd')
dmd(templateData)

produces this markdown output:

<a name="fatUse"></a>
## fatUse
I am a global variable

**Kind**: global variable

© 2014-24 Lloyd Brookes <75pound@gmail.com>.

Tested by test-runner. Documented by jsdoc-to-markdown.

版本列表
7.1.1 2024-11-29
7.1.0 2024-11-28
7.0.7 2024-09-25
7.0.6 2024-09-08
7.0.5 2024-09-01
7.0.4 2024-09-01
7.0.3 2024-08-31
7.0.2 2024-08-31
7.0.1 2024-08-31
7.0.0-3 2024-08-30
7.0.0-2 2024-08-29
7.0.0-1 2024-08-29
7.0.0-0 2024-08-28
7.0.0 2024-08-30
6.3.0-1 2024-08-30
6.2.3 2024-07-24
6.2.2 2024-07-20
6.2.1 2024-07-19
6.2.0 2022-11-28
6.1.0 2022-01-29
6.0.0 2021-02-26
5.0.2 2020-06-14
5.0.1 2020-05-31
5.0.0 2019-12-09
4.0.6 2019-12-11
4.0.5 2019-11-06
4.0.4 2019-09-20
4.0.3 2019-09-05
4.0.2 2019-08-30
4.0.1 2019-08-25
4.0.0 2019-05-12
3.0.13 2018-10-18
3.0.12 2018-04-05
3.0.11 2018-02-23
3.0.10 2018-01-18
3.0.9 2018-01-09
3.0.8 2018-01-09
3.0.7 2017-12-20
3.0.6 2017-05-13
3.0.5 2017-05-11
3.0.4 2017-04-24
3.0.3 2017-03-21
3.0.2 2017-03-04
3.0.1 2017-02-27
3.0.0-0 2017-02-08
3.0.0 2017-02-09
2.1.2 2016-10-19
2.1.1 2016-10-08
2.1.0 2016-10-08
2.0.3-4 2016-09-21
2.0.3-3 2016-08-07
2.0.3-2 2016-08-07
2.0.3-1 2016-08-07
2.0.3-0 2016-08-07
2.0.3 2016-10-05
2.0.2 2016-08-03
2.0.1 2016-08-01
2.0.0 2016-07-28
1.4.2 2016-07-26
1.4.1 2016-05-28
1.4.0 2016-05-24
1.3.11 2016-03-14
1.3.10 2016-03-03
1.3.9 2016-03-02
1.3.8 2016-02-29
1.3.7 2016-02-25
1.3.6 2016-02-24
1.3.5 2016-02-01
1.3.4 2016-01-08
1.3.3 2015-12-19
1.3.2 2015-12-09
1.3.1 2015-12-09
1.3.0 2015-12-09
1.2.2 2015-12-07
1.2.1 2015-11-12
1.2.0 2015-09-21
1.1.1 2015-05-08
1.1.0 2015-05-05
1.0.3 2015-04-20
1.0.2 2015-04-17
1.0.1 2015-04-13
1.0.0 2015-04-12
0.3.25 2015-03-24
0.3.24 2015-03-15
0.3.23 2015-03-15
0.3.22 2015-03-01
0.3.21 2015-02-24
0.3.20 2015-02-22
0.3.19 2015-02-04
0.3.18 2015-02-01
0.3.17 2015-01-29
0.3.16 2015-01-29
0.3.15 2015-01-28
0.3.14 2015-01-18
0.3.13 2015-01-16
0.3.12 2015-01-14
0.3.11 2015-01-12
0.3.10 2015-01-11
0.3.9 2015-01-10
0.3.8 2015-01-10
0.3.7 2015-01-10
0.3.6 2015-01-10
0.3.5 2015-01-06
0.3.4 2014-12-29
0.3.3 2014-12-27
0.3.2 2014-12-25
0.3.1 2014-12-22
0.3.0 2014-12-22
0.2.14 2015-03-01
0.2.13 2015-01-31
0.2.12 2014-12-10
0.2.11 2014-12-10
0.2.10 2014-09-29
0.2.9 2014-09-09
0.2.8 2014-08-15
0.2.7 2014-07-23
0.2.6 2014-07-21
0.2.5 2014-07-21
0.2.4 2014-07-18
0.2.3 2014-07-18
0.2.2 2014-07-17
0.2.1 2014-07-17
0.2.0 2014-07-17
0.1.4 2014-07-15
0.1.3 2014-07-15
0.1.2 2014-07-15
0.1.1 2014-07-14