Skip to content

richmdjs/richmd

Repository files navigation

Richmd

NPM npm npm

What is Richmd?

Richmd is a tool for making Rich contents Markdown language.

Richmd

Installation

# use npm
$ npm install richmd

# use yarn
$ yarn add richmd

Usage

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 🙏