https://github.com/richmd/richmd
Richmd expand basic Markdown syntax to customaize it.
https://github.com/richmd/richmd
codeblocks front-end html katex markdown math richmd typescript
Last synced: 2 months ago
JSON representation
Richmd expand basic Markdown syntax to customaize it.
- Host: GitHub
- URL: https://github.com/richmd/richmd
- Owner: bebeji-nappa
- License: mit
- Created: 2020-12-21T06:06:10.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-10-07T21:15:28.000Z (about 1 year ago)
- Last Synced: 2024-12-01T12:50:24.263Z (10 months ago)
- Topics: codeblocks, front-end, html, katex, markdown, math, richmd, typescript
- Language: TypeScript
- Homepage:
- Size: 42.3 MB
- Stars: 8
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
Awesome Lists containing this project
README
# 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`:
```sh
$ pnpm add @richmd/js
```
Update your imports as follows:
```diff
-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
```bash
# use npm
$ npm install richmd
# use yarn
$ yarn add richmd
```
## Usage
- [Usage for React](./docs/usage-react.md)
- [Usage for Vue](./docs/usage-vue.md)
- [Usage Webpack](./docs/Setup-webpack.md)
### 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.
```js
import { parseTree } from 'richmd';
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
## 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/)