FFFF prism-code-editor/rehype-plugin at main · jonpyt/prism-code-editor · GitHub
[go: up one dir, main page]

Skip to content

Latest commit

 

History

History

README.md

Rehype plugin to create code editors and highlight code blocks using prism code editor.

NPM package

Installation

This plugin has prism-code-editor version 4.0.0 or greater as a peer dependency

npm i prism-code-editor rehype-prism-code-editor

Basic usage

import rehype from "rehype"
import prismCodeEditor from "rehype-prism-code-editor"
import "prism-code-editor/prism/languages/common"

rehype().use(prismCodeEditor, {
  // Configuration options
}).process(/* some html */)

Documentation

For more examples and a detailed description of the included features, check the documentation website.

Demo

There's a demo page where you can write markdown and view the resulting editors and code blocks. Note that the demo uses marked, but this rehype plugin has an identical API and feature set.

Development

To run the development server locally, install dependencies.

pnpm install

Next, you must build the prism-code-editor package.

cd ../package
pnpm install
pnpm build

Finally, you can run the development server to test your changes.

cd ../rehype-plugin
pnpm dev
0