Installations

npm install mdx-prism-2

Pull Requests

Open

0

Total

0

Closed

0

Issues

Open

0

Total

0

Closed

0

Releases

Unable to fetch releases

Developer

raulfdm

Developer Guide

BETA

Module System

ESM

Min. Node Version

Typescript Support

Yes

Node Version

14.18.3

NPM Version

6.14.15 Statistics

1 Stars

50 Commits

2 Watching

2 Branches

1 Contributors

Updated on 07 Mar 2023

Languages

TypeScript (90.82%)

JavaScript (7.45%)

Shell (1.74%)

Total Downloads

Cumulative downloads

Total Downloads

10,776

Last day

0%

1

Compared to previous day

Last week

-87.3%

7

Compared to previous week

Last month

229.4%

112

Compared to previous month

Last year

-29%

908

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

9

hast-util-to-string parse-numeric-range refractor rehype rehype-parse unified unist-util-filter unist-util-visit unist-util-visit-parents

Dev Dependencies

17

@babel/core @babel/preset-env @babel/preset-typescript @typescript-eslint/eslint-plugin @typescript-eslint/parser esbuild esbuild-plugin-d.ts eslint eslint-plugin-simple-import-sort husky jest jest-serializer-html-string prettier pretty-quick scripty tslib typescript

Versions

⚠️ This is Fork from mdx-prism which automate the release process. There are a few fixes that does not have a published version there.

Maybe in the future I can delete this repository in favor of having a single but for now I need things a bit more professional.

mdx-prism-2

This is a fork of @mapbox/rehype-prism that adds line highlighting capabilities, e.g.:

rehype plugin to highlight code blocks in HTML with Prism (via refractor).

(If you would like to highlight code blocks with highlight.js, instead, check out rehype-highlight.)

Best suited for usage in Node. If you would like to perform syntax highlighting in the browser, you should look into less heavy ways to use refractor.

Installation

1npm install mdx-prism-2

API

rehype().use(rehypePrism, [options])

Syntax highlights pre > code. Under the hood, it uses refractor, which is a virtual version of Prism.

The code language is configured by setting a language-{name} class on the <code> element. You can use any language supported by refractor.

If no language-{name} class is found on a <code> element, it will be skipped.

options

Parameter	Type	Default	Description
`ignoreMissing`	`boolean`	`false`	By default, if `{name}` does not correspond to a language supported by refractor an error will be thrown. If you would like to silently skip `<code>` elements with invalid languages, set this option to `true`.
`lineHighlight.component`	`string` (HTML element)	`div`	The HTML tag used to wrap the highlight line.
`lineHighlight.className`	`string`	`mdx-marker`	CSS class applied to highlight line.

Usage

Use this package as a rehype plugin.

Some examples of how you might do that:

1const rehype = require('rehype');
2const mdxPrism = require('mdx-prism-2');
3
4rehype().use(mdxPrism).process(/* some html */);

1const rehype = require('rehype');
2const mdxPrism = require('mdx-prism-2');
3
4rehype()
5  .use(mdxPrism, {
6    lineHighlight: {
7      component: 'span',
8      className: 'my-line-highlight-class',
9    },
10  })
11  .process(/* some html */);

1const unified = require('unified');
2const rehypeParse = require('rehype-parse');
3const mdxPrism = require('mdx-prism-2');
4
5unified().use(rehypeParse).use(mdxPrism).processSync(/* some html */);

If you'd like to get syntax highlighting in Markdown, parse the Markdown (with remark-parse), convert it to rehype, then use this plugin.

1const unified = require('unified');
2const remarkParse = require('remark-parse');
3const remarkRehype = require('remark-rehype');
4const mdxPrism = require('mdx-prism-2');
5
6unified()
7  .use(remarkParse)
8  .use(remarkRehype)
9  .use(mdxPrism)
10  .process(/* some markdown */);

FAQ

Why does mdx-prism-2 copy the language- class to the <pre> tag?

Prism recommends adding the language- class to the <code> tag like this:

1<pre><code class="language-css">p { color: red }</code></pre>

It bases this recommendation on the HTML5 spec. However, an undocumented behavior of their JavaScript is that, in the process of highlighting the code, they also copy the language- class to the <pre> tag:

1<pre
2  class="language-css"
3><code class="language-css"><span class="token selector">p</span> <span class="token punctuation">{</span> <span class="token property">color</span><span class="token punctuation">:</span> red <span class="token punctuation">}</span></code></pre>

This resulted in many Prism themes relying on this behavior by using CSS selectors like pre[class*="language-"]. So in order for people using mdx-prism-2 to get the most out of these themes, we decided to do the same.

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

SAST

Determines if the project uses static code analysis.

0

Maintained

Determines if the project is "actively maintained".

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

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

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

2.5

/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 mdx-prism-2

mdx-prism-2

Installations

Pull Requests

0

0

0

Issues

0

0

0

Releases

Unable to fetch releases

Developer

raulfdm

Developer Guide

ESM

Yes

14.18.3

6.14.15

Statistics

Languages

Total Downloads

10,776

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

mdx-prism-2

Installation

API

options

Usage

FAQ

10

10

10

0

0

0

0

0

0

0

0

0

0

2.5

/10

Other packages similar to mdx-prism-2