rehype-tree-sitter-highlight
v1.0.2
Published
highlight your code using tree-sitter-highlight
Downloads
5
Maintainers
Readme
rehype-tree-sitter-highlight
highlight your code using tree-sitter-highlight
Installation
npm install rehype-tree-sitter-highlight
Usage
This is a rehype plugin. To highlight code blocks in html:
import fromHtml from 'rehype-parse'
import toHtml from 'rehype-stringify'
import rehypeTreeSitterHighlight from 'rehype-tree-sitter-highlight'
import { unified } from 'unified'
const doc = "```js\nconst hello = 'World';\n```\n"
async function createProcessor() {
const processor = unified()
.use(fromHtml)
.use(rehypeTreeSitterHighlight)
.use(toHtml)
return processor
}
const processor = await createProcessor()
const vfile = await processor.process(doc)
console.log(vfile.toString())
Configuration
Theme
Refer to the tree-sitter-highlight docs for information on how to theme the output html.
Supported Languages
Refer to the tree-sitter-highlight for supported languages.
Unknown Languages
Unknown languages are ignored by default. You can set ignoreUnknownLanguage: false
to throw an error when an unsupported language is encountered.
Examples
See examples for ways to use this plugin.
Inspiration
Much of the docs and code is taken from rehype-shiki.