markdown-code-example-inserter

v3.0.0

Syncs code examples with markdown documentation. For more information about how to use this package see README

Latest version published 1 month ago

License: CC0-1.0

NPM

GitHub

Package Health Score

60 / 100

security
No known security issues
popularity
Limited
maintenance
Sustainable
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

All Versions

Version				Vulnerabilities	License Risk
3.0.0	\|	09/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.0.4	\|	09/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.0.0	\|	02/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.3.3	\|	11/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.2.0	\|	02/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

CC0-1.0

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

Limited

Weekly Downloads (672)

GitHub Stars: 1
Forks: 0
Contributors: -

Direct Usage Popularity

The npm package markdown-code-example-inserter receives a total of 672 downloads a week. As such, we scored markdown-code-example-inserter popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package markdown-code-example-inserter, we found that it has been starred 1 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: 0
Funding: No

This project has seen only 10 or less contributors.

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

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

Open Issues: 0
Open PR: 0
Last Release: 1 month ago
Last Commit: 1 month ago

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

We found that markdown-code-example-inserter demonstrates a positive version release cadence with at least one new version released in the past 3 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: >=22

Age: 3 years
Dependencies: 11 Direct
Versions: 33
Install Size: 672 kB
Dist-tags: 1
# of Files: 73
Maintainers: 1
TS Typings: No

markdown-code-example-inserter 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

markdown-code-example-inserter

Syncs markdown documentation with code examples.

Install

Via npm:

npm i -D markdown-code-example-inserter

It's recommended to install this package as a dev dependency as it is a build-step operation.

Usage

Markdown files

Add an HTML comment that starts with the following text: example-link:. Then after that text, include a file path to the example file:

Here's an example from the GitHub repo. And here is the same file with the code examples inserted.

CLI

npx md-code file1.md file2.md [...moreFiles]

Any of the file names can be a glob. Put the glob in quotes if you wish to prevent your shell from expanding it (this package will expand the glob):

npx md-code "./*.md"

Check only

Use --check.

Check if the given files are updated, don't write anything.

npx md-code file1.md --check

Force an index file

Use --index.

Force an index file for imports that should be rewritten with your package name:

npx md-code file1.md --index path/to/index.ts file2.md [...moreFiles]

The index file is used to replace relative imports with package name imports. Like changing import from '../../index' to import from 'my-package'.

Ignore a pattern

Use --ignore.

npx md-code "./**/*.md" --ignore "./test-files/**/*"

Multiple --ignore patterns can be used:

npx md-code "./**/*.md" --ignore "./test-files/**/*" -ignore "./test-files/**/*"

node_modules is automatically ignored.

Turn off logging

Use --silent

npx md-code --silent file1.md

markdown-code-example-inserter dependencies

@augment-vir/assert @augment-vir/common @augment-vir/node cli-args-vir glob rehype-parse remark-parse remark-rehype tsx typescript unified

FAQs

What is markdown-code-example-inserter?

Syncs code examples with markdown documentation. Visit Snyk Advisor to see a full health score report for markdown-code-example-inserter, including popularity, security, maintenance & community analysis.

Is markdown-code-example-inserter popular?

The npm package markdown-code-example-inserter receives a total of 672 weekly downloads. As such, markdown-code-example-inserter popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is markdown-code-example-inserter well maintained?

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

Is markdown-code-example-inserter safe to use?

The npm package markdown-code-example-inserter 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 29 October-2024, at 19:54 (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

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (672)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

markdown-code-example-inserter

Install

Usage

Markdown files

CLI

Check only

Force an index file

Ignore a pattern

Turn off logging

markdown-code-example-inserter dependencies

markdown-code-example-inserter development dependencies

FAQs

What is markdown-code-example-inserter?

Is markdown-code-example-inserter popular?

Is markdown-code-example-inserter well maintained?

Is markdown-code-example-inserter 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