1.0.1 • Published 3 years ago

rehype-source-map v1.0.1

Weekly downloads
-
License
MIT
Repository
github
Last release
3 years ago

rehype-source-map

rehype plugin to attach positional info (e.g. "start-line") to elements (e.g. via the data-line attribute).

Input:

First line

Second line

Output:

<p data-line="1">First line</p>
<p data-line="3">Second line</p>

Install

This package is ESM only: Node 12+ is needed to use it and it must be imported instead of required.

yarn:

yarn add rehype-source-map

Use

The plugin should be used for rehype-ed content (i.e. after remark-rehype or retext-rehype). There is no options at the moment.

import { unified } from "unified";
import remarkParse from "remark-parse";
import remarkRehype from "remark-rehype";
import rehypeStringify from "rehype-stringify";
import { rehypeSourceMap } from "rehype-source-map";

unified()
	.use(remarkParse)
	.use(remarkRehype)
	.use(rehypeStringify)
	.use(rehypeSourceMap)
	.process(/* you know the drill */);