remark-prism
Advanced tools
Syntax highlighter for markdown code blocks - with support for plugins
Syntax highlighter for markdown code blocks using Prism - with support for certain plugins. This allows syntax highlighting without running any client-side code - other than CSS.
λ yarn add remark-prism
Input:
const src = `
\`\`\`javascript
console.log('Hello World');
\`\`\`
`;
Using remark (mdast):
require('unified')()
.use(require('remark-parse'))
.use(require('remark-stringify'))
.use(require('remark-prism'), {
/* options */
})
.use(require('remark-html'))
.process(file, (err, file) => console.log(String(file)));
Using rehype (hast):
require('unified')()
.use(require('remark-parse'))
.use(require('remark-prism'), {
/* options */
})
.use(require('remark-rehype'))
.use(require('rehype-format'))
.use(require('rehype-stringify'))
.process(file, (err, file) => console.log(String(file)));
Using mdx:
console.log(
await require('@mdx-js/mdx')(src, {
commonmark: true,
gfm: true,
remarkPlugins: [
[
require('remark-prism'),
{
/* options */
},
],
],
}),
);
Output:
<div class="remark-highlight">
<pre class="language-javascript">
<code>
<span class="token console class-name">console</span>
<span class="token punctuation">.</span>
<span class="token method function property-access">log</span>
<span class="token punctuation">(</span>
<span class="token string">'Hello World'</span>
<span class="token punctuation">)</span>
<span class="token punctuation">;</span>
</code>
</pre>
</div>
Take a look at our fixtures and it's outputs to see more examples.
transformInlineCodeAdd relevant class names to inline code snippets. For example when you use single backtick code examples.
use(require('remark-prism'), {
transformInlineCode: true,
});
It supports some Prism plugins:
use(require('remark-prism'), {
plugins: [
'autolinker',
'command-line',
'data-uri-highlight',
'diff-highlight',
'inline-color',
'keep-markup',
'line-numbers',
'show-invisibles',
'treeview',
],
});
Don't forget to include the appropriate css in your stylesheets. Refer to the documentation of each plugin.
\`\`\`diff-javascript[class="line-numbers"][class="diff-highlight"]
<pre class="language-diff-javascript diff-highlight line-numbers">...</pre>
BSD-3-Clause
1.3.6 (2021-04-13)
FAQs
Syntax highlighter for markdown code blocks - with support for plugins
The npm package remark-prism receives a total of 2,566 weekly downloads. As such, remark-prism popularity was classified as popular.
We found that remark-prism demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.