npmpackage.info

Gathering detailed insights and metrics for jsdoc-to-markdown

Other packages similar to jsdoc-to-markdown

dmd

7.0.7

The default output template for jsdoc-to-markdown

@types/jsdoc-to-markdown

7.0.6

TypeScript definitions for jsdoc-to-markdown

docdown

0.7.3

A simple JSDoc to Markdown documentation generator.

gulp-jsdoc-to-markdown

1.2.2

Plugin for jsdoc-to-markdown. Works in both buffer and streaming modes.

Gathering detailed insights and metrics for jsdoc-to-markdown

jsdoc-to-markdown

Generate markdown documentation from jsdoc-annotated javascript

9.0.5

1,692

MIT

JavaScript

29,898,228 4.4

Installations

npm install jsdoc-to-markdown

Score

54.5

Supply Chain

Quality

88.4

Maintenance

100

Vulnerability

96.7

License

Pull Requests

Open

0

Total

12

Closed

5

Merged

7

Issues

Open

26

Total

270

Closed

244

Releases

v9.0.5

Published on 01 Nov 2024

v9.0.4

Published on 19 Oct 2024

v9.0.3

Published on 19 Oct 2024

v9.0.2

Published on 25 Sept 2024

v9.0.0

Published on 01 Sept 2024

v8.0.0

Published on 28 Nov 2022

View all 15 releases

Developer

jsdoc2md

Developer Guide

BETA

Module System

ESM

Min. Node Version

>=12.17

Typescript Support

No

Node Version

23.1.0

NPM Version

10.9.0 Statistics

1,692 Stars

1,036 Commits

152 Forks

15 Watching

2 Branches

8 Contributors

Updated on 19 Nov 2024

Languages

JavaScript (100%)

Total Downloads

Cumulative downloads

Total Downloads

29,898,228

Last day

-30.2%

41,174

Compared to previous day

Last week

-2.6%

268,540

Compared to previous week

Last month

55.7%

989,184

Compared to previous month

Last year

14.7%

7,284,590

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

array-back command-line-args command-line-usage config-master dmd jsdoc-api jsdoc-parse walk-back

Peer Dependencies

@75lb/nature

Versions

Upgraders, please read the release notes

jsdoc-to-markdown

Generates markdown API documentation from jsdoc annotated source code. Useful for injecting API docs into project README files.

Synopsis

1. Document your code using valid jsdoc comments.

1/**
2 * A quite wonderful function.
3 * @param {object} - Privacy gown
4 * @param {object} - Security
5 * @returns {survival}
6 */
7function protection (cloak, dagger) {}

2. Run a command.

1$ jsdoc2md example.js

3. Get markdown output.

1## protection(cloak, dagger) ⇒ <code>survival</code>
2A quite wonderful function.
3
4**Kind**: global function
5
6| Param  | Type                | Description  |
7| ------ | ------------------- | ------------ |
8| cloak  | <code>object</code> | Privacy gown |
9| dagger | <code>object</code> | Security     |
10

Install

$ npm install --save-dev jsdoc-to-markdown

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Security-Policy

Determines if the project has published a security policy.

Score

4.4

/10

Last Scanned on 2024-11-18

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to jsdoc-to-markdown

Other packages similar to jsdoc-to-markdown

jsdoc-to-markdown

Installations

Score

Pull Requests

0

12

5

7

Issues

26

270

244

Releases

Developer

jsdoc2md

Developer Guide

ESM

>=12.17

No

23.1.0

10.9.0

Statistics

Languages

Total Downloads

29,898,228

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

jsdoc-to-markdown

Synopsis

Install

See also

10

10

10

10

10

0

0

0

0

0

0

0

0

4.4

/10