View @markdoc/markdoc on Snyk Open Source Advisor

Package Health Score

85 / 100

security
No known security issues
popularity
Popular
maintenance
Sustainable
community
Active

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
0.4.0	\|	12/2023	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.3.5	\|	11/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.2.2	\|	02/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.1.13	\|	10/2022		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 (71,918)

GitHub Stars: 7.28K
Forks: 168
Contributors: 20

Direct Usage Popularity

The npm package @markdoc/markdoc receives a total of 71,918 downloads a week. As such, we scored @markdoc/markdoc popularity level to be Popular.

Based on project statistics from the GitHub repository for the npm package @markdoc/markdoc, we found that it has been starred 7,277 times.

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

Community

Active

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

With more than 10 contributors for the @markdoc/markdoc repository, this is possibly a sign for a growing and inviting community.

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

Open Issues: 22
Open PR: 0
Last Release: 11 months ago
Last Commit: 1 month ago

Further analysis of the maintenance status of @markdoc/markdoc based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that @markdoc/markdoc demonstrates a positive version release cadence with at least one new version released in the past 12 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: >=14.7.0

Age: 2 years
Dependencies: 1 Direct
Versions: 25
Install Size: 1.9 MB
Dist-tags: 1
# of Files: 124
Maintainers: 3
TS Typings: No

@markdoc/markdoc 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

A powerful, flexible, Markdown-based authoring framework.

Markdoc is a Markdown-based syntax and toolchain for creating custom documentation sites and experiences.
We designed Markdoc to power Stripe's public docs, our largest and most complex content site.

Installation

To get started with Markdoc, first install the library:

npm install @markdoc/markdoc

yarn add @markdoc/markdoc

and import it in your app:

const Markdoc = require('@markdoc/markdoc');

or if you are using ESM

import Markdoc from '@markdoc/markdoc';

then use Markdoc in your app or tool:

const doc = `
# Markdoc README

{% image src="/logo.svg" /%}
`;

const ast = Markdoc.parse(doc);
const content = Markdoc.transform(ast);
return Markdoc.renderers.react(content, React);

Check out our docs for more guidance on how to use Markdoc.

TypeScript

This is the minimal tsconfig.json required to use Markdoc in your TypeScript project:

{
  "compilerOptions": {
    "moduleResolution": "node",
    "target": "esnext", // works with es2015 or greater
    "esModuleInterop": true
  }
}

React

If you are using React, install Markdoc with:

npm install @markdoc/markdoc react @types/react

Contributing

Contributions and feedback are welcome and encouraged. Check out our contributing guidelines on how to do so.

Development

Run npm install
Run npm run build
Run the tests using npm test

Code of conduct

This project has adopted the Stripe Code of conduct.

License

This project uses the MIT license.

Credits

Special shout out to:

@marcioAlmada for providing us with the @markdoc GitHub org.
@koomen for gifting us https://markdoc.dev.

@markdoc/markdoc dependencies

@types/markdown-it

@markdoc/markdoc development dependencies

@types/jasmine @types/node @typescript-eslint/eslint-plugin @typescript-eslint/parser deep-assert diff esbuild eslint jasmine jest-diff markdown-it patch-package pegjs prettier ts-eager typedoc typescript yaml-js

FAQs

What is @markdoc/markdoc?

A text markup language for documentation. Visit Snyk Advisor to see a full health score report for @markdoc/markdoc, including popularity, security, maintenance & community analysis.

Is @markdoc/markdoc popular?

The npm package @markdoc/markdoc receives a total of 71,918 weekly downloads. As such, @markdoc/markdoc popularity was classified as a popular. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is @markdoc/markdoc well maintained?

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

Is @markdoc/markdoc safe to use?

The npm package @markdoc/markdoc 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 4 November-2024, at 08:08 (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 (71,918)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

A powerful, flexible, Markdown-based authoring framework.

Installation

TypeScript

React

Contributing

Development

Code of conduct

License

Credits

@markdoc/markdoc dependencies

@markdoc/markdoc development dependencies

FAQs

What is @markdoc/markdoc?

Is @markdoc/markdoc popular?

Is @markdoc/markdoc well maintained?

Is @markdoc/markdoc 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