Richmd (Legacy package)

WARNING: richmd is now in maintenance mode.

With the release of the latest Richmd v3, this package has entered maintenance mode.

Migration is simple and straightforward.

Migrating from v2 to v3

Install @richmd/js:

$ pnpm add @richmd/js

Update your imports as follows:

-import { richmd } from 'richmd'
-import 'richmd/richmd.css'
+import { richmd } from '@richmd/js'
+import "@richmd/js/dist/richmd.css";

Upcoming Schedule

• From 2025/03/23: All methods in this package will be deprecated and development will end.
• By June 2025: This repository will be archived and the npm package will be marked as deprecated.

What is Richmd?

Richmd is a tool for making Rich contents Markdown language.

Installation

# use npm
$ npm install richmd

# use yarn
$ yarn add richmd

Usage

• Usage for React
• Usage for Vue
• Usage Webpack

Retrieve Abstract Syntax Tree (AST) Data

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

import { parseTree } from 'richmd';

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

License

MIT

Thank you :pray:

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