Package Health Score

58 / 100

security
No known security issues
popularity
Small
maintenance
Inactive
community
Limited

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
7.3.2	\|	12/2023	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
7.2.5	\|	01/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
6.0.1	\|	09/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L
5.2.5	\|	07/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L
5.1.8	\|	09/2020		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

Small

Weekly Downloads (5,945)

GitHub Stars: 79
Forks: 42
Contributors: 7

Direct Usage Popularity

The npm package apidoc-markdown receives a total of 5,945 downloads a week. As such, we scored apidoc-markdown popularity level to be Small.

Based on project statistics from the GitHub repository for the npm package apidoc-markdown, we found that it has been starred 79 times.

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

Community

Limited

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

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like apidoc-markdown is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

Open Issues: 0
Open PR: 0
Last Release: 11 months ago
Last Commit: 11 months ago

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

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

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

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: >=14.0.0

Age: 11 years
Dependencies: 5 Direct
Versions: 44
Install Size: 124 kB
Dist-tags: 2
# of Files: 17
Maintainers: 1
TS Typings: Yes

apidoc-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.

Readme

📝 Generate a Simple and Portable Markdown documentation for your API

apidoc-markdown

Before starting

apidoc-markdown uses apiDoc internally. To generate your nice Markdown documentation, you first need to add some apiDoc API documentation comments in your code.

Take a look at https://apidocjs.com/ to discover it if it's your first time using it! 😉

You create your API documentation directly in your code with comments like this:

/**
 * @api {post} /admin/invite/new Send Invite
 * @apiPermission GlobalAdmin
 * @apiDescription Create &amp; email a new Strider invite.
 * @apiName SendInvite
 * @apiGroup Admin
 * @apiVersion 1.0.0
 *
 * @apiExample {curl} CURL Example:
 *    curl -X POST -d invite_code=xoxox -d email=me[at]email.com https://localhost/invite/new
 *
 * @apiParam (RequestBody) {String} invite_code The invite code/token to use in the invitation
 * @apiParam (RequestBody) {String} email The email address of the new user being invited
 */
app.post('/invite/new', (req, res) =&gt; res.end())

How does it look? Give me some examples!

Some examples are available in the example directory.

Take a look at example/strider/api.md which shows a real-world example taken from the Strider API.

Install

# For the global CLI
pnpm install --global apidoc-markdown

# For programmatic usage or local project CLI install
pnpm install apidoc-markdown

Then, generate your documentation using your newly added command apidoc-markdown or programmatically.

Note: Node.js v14+ minimum is required. apidoc-markdown uses apidoc-light internally.

CLI usage

Generate a Simple and Portable Markdown documentation for your API.
Usage: apidoc-markdown -i

apidoc-markdown dependencies

apidoc-light ejs semver update-notifier yargs

apidoc-markdown development dependencies

@types/ejs @types/node @types/semver @types/yargs ava fs-extra typescript

FAQs

What is apidoc-markdown?

📝 Generate a Simple and Portable Markdown documentation for your API. Visit Snyk Advisor to see a full health score report for apidoc-markdown, including popularity, security, maintenance & community analysis.

Is apidoc-markdown popular?

The npm package apidoc-markdown receives a total of 5,945 weekly downloads. As such, apidoc-markdown popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is apidoc-markdown well maintained?

We found indications that apidoc-markdown is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is apidoc-markdown safe to use?

The npm package apidoc-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 22 November-2024, at 03:56 (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

apidoc-markdown

📝 Generate a Simple and Portable Markdown documentation for your API 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 (5,945)

Direct Usage Popularity

Community

Embed Package Health Score Badge

Maintenance

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Package

Readme

apidoc-markdown

Before starting

How does it look? Give me some examples!

Install

CLI usage

apidoc-markdown dependencies

apidoc-markdown development dependencies

FAQs

What is apidoc-markdown?

Is apidoc-markdown popular?

Is apidoc-markdown well maintained?

Is apidoc-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 (5,945)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

apidoc-markdown

Before starting

How does it look? Give me some examples!

Install

CLI usage

apidoc-markdown dependencies

apidoc-markdown development dependencies

FAQs

What is apidoc-markdown?

Is apidoc-markdown popular?

Is apidoc-markdown well maintained?

Is apidoc-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