Package Health Score

76 / 100

security
No known security issues
popularity
Popular
maintenance
Sustainable
community
Sustainable

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
9.0.5	\|	11/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
8.0.3	\|	07/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
7.1.1	\|	01/2022	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
6.0.1	\|	05/2020		0 C 0 H 0 M 0 L	0 H 0 M 0 L
5.0.3	\|	11/2019		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Popular

Weekly Downloads (230,777)

GitHub Stars: 1.69K
Forks: 152
Contributors: 8

Direct Usage Popularity

The npm package jsdoc-to-markdown receives a total of 230,777 downloads a week. As such, we scored jsdoc-to-markdown popularity level to be Popular.

Based on project statistics from the GitHub repository for the npm package jsdoc-to-markdown, we found that it has been starred 1,688 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: Yes
Contributors: 8
Funding: No

This project has seen only 10 or less contributors.

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

Open Issues: 26
Open PR: 0
Last Release: 20 days ago
Last Commit: 20 days ago

Further analysis of the maintenance status of jsdoc-to-markdown based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that jsdoc-to-markdown demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >=12.17

Age: 11 years
Dependencies: 8 Direct
Versions: 134
Install Size: 31.2 kB
Dist-tags: 1
# of Files: 9
Maintainers: 1
TS Typings: Yes

jsdoc-to-markdown has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Not sure how to use jsdoc-to-markdown?

To help you get started, we've collected the most common ways that jsdoc-to-markdown is being used within popular public projects.

ff0000-ad-tech / ad-docs / lib / index.js View on Github

async function createMarkdownFromClasses(packageName, outputDir, api, readme) {
	console.log('createMarkdownFromClasses()')

	const { outputDocsDir, templateData } = setup(outputDir, true)

	// reduce templateData to an array of class names
	const classNames = templateData.reduce((classNames, identifier) =&gt; {
		if (identifier.kind === 'class') classNames.push(identifier.name)
		return classNames
	}, [])

	// create a documentation file for each class
	for (const className of classNames) {
		const template = `{{#class name="${className}"}}{{&gt;docs}}{{/class}}`
		const output = jsdoc2md.renderSync({ data: templateData, template: template })
		fs.writeFileSync(path.resolve(outputDocsDir, `${className}.md`), output)
	}

	let apiOutput = await prepApi(api, templateData)

	apiOutput = mergeAndRepathHeaderLink(apiOutput, './')

	// use to convert links from page scroll to nav to other md files
	apiOutput = apiOutput.replace(/(\[)([^\]]+)(\]\(#([^\)]+)\))/g, (full, a, b, c, d) =&gt; {
		// split to see if it is a method or property
		const split = d.split('.')
		return split.length &gt; 1 ? `<a href="./docs/${split[0]}.md#${d}">${b}</a>` : b
	})

	combineAndWrite(packageName, outputDir, apiOutput, readme)
}

View more ways to use jsdoc-to-markdown

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.

/**
 * A quite wonderful function.
 * @param {object} - Privacy gown
 * @param {object} - Security
 * @returns {survival}
 */
function protection (cloak, dagger) {}

2. Run a command.

$ jsdoc2md example.js

3. Get markdown output.

## 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

jsdoc-to-markdown dependencies

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

FAQs

What is jsdoc-to-markdown?

Generates markdown API documentation from jsdoc annotated source code. Visit Snyk Advisor to see a full health score report for jsdoc-to-markdown, including popularity, security, maintenance & community analysis.

Is jsdoc-to-markdown popular?

The npm package jsdoc-to-markdown receives a total of 230,777 weekly downloads. As such, jsdoc-to-markdown popularity was classified as a popular. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is jsdoc-to-markdown well maintained?

We found indications that jsdoc-to-markdown maintenance is sustainable demonstrating some project activity. We saw a total of 8 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is jsdoc-to-markdown safe to use?

The npm package jsdoc-to-markdown was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 21 November-2024, at 04:55 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

jsdoc-to-markdown

Generates markdown API documentation from jsdoc annotated source code For more information about how to use this package see README

Ensure you're using the healthiest npm packages

Package Health Score

Explore Similar Packages

Security

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Popularity

Weekly Downloads (230,777)

Direct Usage Popularity

Community

Embed Package Health Score Badge

Maintenance

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Package

Not sure how to use jsdoc-to-markdown?

jsdoc-to-markdown

Synopsis

Install

See also

jsdoc-to-markdown dependencies

FAQs

What is jsdoc-to-markdown?

Is jsdoc-to-markdown popular?

Is jsdoc-to-markdown well maintained?

Is jsdoc-to-markdown safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Fix identified vulnerabilities

Monitor for new issues

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (230,777)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Not sure how to use jsdoc-to-markdown?

jsdoc-to-markdown

Synopsis

Install

See also

jsdoc-to-markdown dependencies

FAQs

What is jsdoc-to-markdown?

Is jsdoc-to-markdown popular?

Is jsdoc-to-markdown well maintained?

Is jsdoc-to-markdown safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues