Markdown parser, done right. 100% CommonMark support, extensions, syntax plugins & high speed
https://markdown-it.github.io/
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Vitaly Puzrin
2620dcebb0
|
2 months ago | |
|---|---|---|
| .github | 2 months ago | |
| benchmark | 3 months ago | |
| bin | 3 months ago | |
| docs | 2 months ago | |
| src | 2 months ago | |
| support | 2 months ago | |
| test | 2 months ago | |
| .editorconfig | 12 years ago | |
| .gitattributes | 6 years ago | |
| .gitignore | 5 months ago | |
| CHANGELOG.md | 2 months ago | |
| CONTRIBUTING.md | 2 months ago | |
| LICENSE | 12 years ago | |
| README.md | 2 months ago | |
| eslint.config.mjs | 3 months ago | |
| package-lock.json | 3 months ago | |
| package.json | 3 months ago | |
| tsconfig.json | 3 months ago | |
| typedoc.config.mjs | 2 months ago | |
README.md
markdown-it
Markdown parser done right. Fast and easy to extend.
- Follows the CommonMark spec + adds syntax extensions & sugar (URL autolinking, typographer).
- Configurable syntax! You can add new rules and even replace existing ones.
- High speed.
- Safe by default.
- Community-written plugins and other packages on npm.
[!NOTE] If you are upgrading to v15, see the migration guide.
Documentation >>
Install (node.js):
npm install markdown-it
For a quick look at dist/ folder contents, see https://unpkg.com/markdown-it/.
For browser you can use unpkg.com, esm.sh or any other CDN, which mirror npm
registry.
Usage
import MarkdownIt from 'markdown-it'
const md = new MarkdownIt()
const result = md.render('# markdown-it rulezz!')