Richmd

What is Richmd?

Richmd is a tool for making Rich contents Markdown language.

Usage

In general, installing @richmd/core is not necessary. For actual usage, we recommend using one of the following packages instead.

JavaScript (TypeScript)

For more details, please see the README of @richmd/js.

pnpm add @richmd/js

React

For more details, please see the README of @richmd/react.

pnpm add @richmd/react

Vue

For more details, please see the README of @richmd/vue.

pnpm add @richmd/vue

Methods

parseTree()

You can retrieve Abstract Syntax Tree (AST) data using the parseTree method. This is useful for customizing code generation on your own.

To use the parser standalone, you need to install @richmd/core.

$ pnpm add @richmd/core

Sample

import { parseTree } from '@richmd/core';

const text = `# aaaa
## aaaaa

**aaaaaa**
`

const ast = parseTree(text);

Markdown Syntax

Please read Richmd Markdown Syntax Documentation.

Supported Syntax

• strong
• italic
• image
• link
• headings
• horizontal rule
• blockquote
• unordeed list
• ordered list
• strikethrough
• code block
• checkbox list
• table
• TeX syntax (using KaTeX)
• Color Inline Block
• Dropdown details
• Video(HTML5 Video Tag)
• Custom HTML Tag
• Slide Mode (v4 ~)

License

MIT

Thank you 🙏

• Markdown-tree-parser
  • Richmd's Markdown parser was created using the code in markdown-tree-parser as a reference.
• KaTeX
• highlight.js