notion-rehype

Turn Notion blocks(from API) into rehype(hast), so you can make the most of the rich rehype ecosystem.

Usage

``js
import { unified } from 'unified';
import notionRehype from 'notion-rehype';
import rehypeKatex from 'rehype-katex';
import rehypeStringify from 'rehype-stringify';

const notionBlocks = [
{
// ... some properties omitted
type: 'paragraph',
paragraph: {
// ... some properties omitted
rich_text: [{ plain_text: 'This is a Notion paragraph' }],
},
},
];

const processor = unified()
.use(notionRehype) // Parse Notion blocks to rehype AST
.use(rehypeKatex) // Then you can use any rehype plugins to enrich the AST
.use(rehypeStringify); // Turn AST to HTML string

// Due to the limitation of the .process() method,
// notion blocks should be passed in with a wrapper { data: xxx };
const vFile = unifiedInst.process({ data: notionBlocks });
// Or you can pass a string in.
// The plugin will use JSON.parse to parse any string argument.
const vFile = unifiedInst.process(JSON.stringify(notionBlocks));

const html = vFile.toString(); // get the output HTML string
assert(html === '

This is a Notion paragraph

The plugin offers many options to customize the output, you can set options in this way: .use(notionRehype, { ...options })

| Option | Type | Default Value | Description |
| --------------------- | ------------------------------------------------------------ | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| notionPrefix | string | 'notion-' | The prefix of the classes and attributes that relates to Notion. e.g.