A RetroSearch Logo

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Search Query:

Showing content from https://www.npmjs.com/package/rehype-code-meta below:

rehype-code-meta - npm

This package is a unified (rehype) plugin to copy code.data.meta to code.properties.metastring.

unified is a project that transforms content with abstract syntax trees (ASTs) using the new parser micromark. remark adds support for markdown to unified. mdast is the Markdown Abstract Syntax Tree (AST) which is a specification for representing markdown in a syntax tree. rehype is a tool that transforms HTML with plugins. hast stands for HTML Abstract Syntax Tree (HAST) that rehype uses.

This plugin finds the <code> elements in hast, and copies code.data.meta to code.properties.metastring.

The plugin rehype-code-meta is useful if you use rehype-raw hence hast-util-raw since it destroys the code.data.meta. Use rehype-code-meta to copy code.data.meta to code.properties.metastring to preserve tha data before rehype-raw and hast-util-raw.

Some rehype plugins utilize the information in the code.data.meta. Since rehype-raw destroys it, that rehype plugins also utilize code.properties.metastring in case rehype-raw is in the plugin chain.

Don't forget to remove code.properties.metastring in the end. The rehype plugins that utilize code.properties.metastring already remove it in most cases, hence you don't need to do anything.

This package is suitable for ESM only. In Node.js (version 16+), install with npm:

npm install rehype-code-meta

or

yarn add rehype-code-meta

Say we have the following markdown file, example.md, and you want to add line numbering to the code via rehype-highlight-code-lines.

```javascript showLineNumbers
const me = "ipikuka";
```

And our module, example.js, looks as follows:

import { read } from "to-vfile";
import remark from "remark";
import gfm from "remark-gfm";
import remarkRehype from "remark-rehype";
import rehypeCodeMeta from "rehype-code-meta";
import rehypeRaw from "rehype-raw";
import rehypeHighlightCodeLines from "rehype-highlight-code-lines";
import rehypeStringify from "rehype-stringify";

main();

async function main() {
  const file = await remark()
    .use(gfm)
    .use(remarkRehype)
    .use(rehypeCodeMeta)
    .use(rehypeRaw)
    .use(rehypeHighlightCodeLine)
    .process(await read("example.md"));

  console.log(String(file));
}

Now, running node example.js you see that the code lines are numbered thanks to rehype-code-meta. Otherwise, without rehype-code-meta, the rehype-highlight-code-lines can't find the information showLineNumbers in the code.data.meta due to rehype-raw.

There is no any option. It is opinionated.

This plugin modifies the hast (HTML abstract syntax tree).

This package is fully typed with TypeScript. The plugin doesn't export any type.

This plugin works with rehype-parse version 1+, rehype-stringify version 1+, rehype version 1+, and unified version 4+.

Use of rehype-code-meta involves rehype (hast), but doesn't lead to cross-site scripting (XSS) attacks.

I like to contribute the Unified / Remark / MDX ecosystem, so I recommend you to have a look my plugins.

MIT License © ipikuka


RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4