https://github.com/richmd/core
Richmd expand basic Markdown syntax to customaize it. This is @richmd/core package.
https://github.com/richmd/core
code katex markdown markdown-parser richmd
Last synced: 5 months ago
JSON representation
Richmd expand basic Markdown syntax to customaize it. This is @richmd/core package.
- Host: GitHub
- URL: https://github.com/richmd/core
- Owner: richmd
- License: mit
- Created: 2025-03-22T05:40:45.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-04-03T11:29:06.000Z (10 months ago)
- Last Synced: 2025-07-18T08:36:57.226Z (6 months ago)
- Topics: code, katex, markdown, markdown-parser, richmd
- Language: TypeScript
- Homepage:
- Size: 2.99 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Richmd v4
## 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](https://github.com/richmd/js).
```sh
pnpm add @richmd/js
```
### React
For more details, please see the README of [@richmd/react](https://github.com/richmd/react).
```sh
pnpm add @richmd/react
```
### Vue
For more details, please see the README of [@richmd/vue](https://github.com/richmd/vue).
```sh
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`.
```sh
$ pnpm add @richmd/core
```
#### Sample
```js
import { parseTree } from '@richmd/core';
const text = `# aaaa
## aaaaa
**aaaaaa**
`
const ast = parseTree(text);
```
## Markdown Syntax
Please read [Richmd Markdown Syntax Documentation](./docs/md-syntax.md).
### Supported Syntax
- strong
- italic
- image
- link
- headings
- horizontal rule
- blockquote
- unordeed list
- ordered list
- strikethrough
- code block
- checkbox list
- table
- TeX syntax (using [KaTeX](https://katex.org/))
- Color Inline Block
- Dropdown details
- Video(HTML5 Video Tag)
- Custom HTML Tag
- [Slide Mode (v4 ~)](./docs/slide-mode.md)
## License
MIT
## Thank you :pray:
- [Markdown-tree-parser](https://github.com/ysugimoto/markdown-tree-parser)
- Richmd's Markdown parser was created using the code in markdown-tree-parser as a reference.
- [KaTeX](https://github.com/KaTeX/KaTeX)
- [highlight.js](https://github.com/highlightjs/highlight.js/)