markdown-it
Markdown parser, done right. 100% CommonMark support, extensions, syntax plugins & high speed
File Explorer
- bug_report.md
- change_proposal.md
- ci.yml
- track-ref-pathological.yml
- funding.json
- package-lock.json
- package.json
- index.mjs
- index.mjs
- index.mjs
- index.mjs
- index.mjs
- block-bq-flat.md
- block-bq-nested.md
- block-code.md
- block-fences.md
- block-heading.md
- block-hr.md
- block-html.md
- block-lheading.md
- block-list-flat.md
- block-list-nested.md
- block-ref-flat.md
- block-ref-list.md
- block-ref-nested.md
- block-tables.md
- inline-autolink.md
- inline-backticks.md
- inline-em-flat.md
- inline-em-nested.md
- inline-em-worst.md
- inline-entity.md
- inline-escape.md
- inline-html.md
- inline-links-flat.md
- inline-links-nested.md
- inline-newlines.md
- lorem1.txt
- rawtabs.md
- README.md
- benchmark.mjs
- profile.mjs
- markdown-it.mjs
- document_post_processing.md
- renderer_rules.md
- text_decoration.md
- migration_v15.md
- migration_v4.md
- migration_v5.md
- architecture.md
- authors.md
- benchmark.md
- development.md
- references.md
- safety.md
- syntax_plugins.md
- usage.md
- html_blocks.ts
- html_re.ts
- utils.ts
- index.ts
- parse_link_destination.ts
- parse_link_label.ts
- parse_link_title.ts
- commonmark.ts
- default.ts
- zero.ts
- blockquote.ts
- code.ts
- fence.ts
- heading.ts
- hr.ts
- html_block.ts
- lheading.ts
- list.ts
- paragraph.ts
- reference.ts
- state_block.ts
- table.ts
- block.ts
- inline.ts
- linkify.ts
- normalize.ts
- replacements.ts
- smartquotes.ts
- state_core.ts
- strip_references.ts
- text_join.ts
- autolink.ts
- backticks.ts
- balance_pairs.ts
- emphasis.ts
- entity.ts
- escape.ts
- fragments_join.ts
- html_inline.ts
- image.ts
- link.ts
- linkify.ts
- newline.ts
- state_inline.ts
- strikethrough.ts
- text.ts
- external.d.ts
- index.ts
- markdownit.ts
- package.json
- parser_block.ts
- parser_core.ts
- parser_inline.ts
- renderer.ts
- ruler.ts
- token.ts
- types.ts
- index.css
- index.html
- index.mjs
- README.md
- sample.md
- condensed_theme.css
- condensed_theme_plugin.mjs
- build-dist.mjs
- build_demo.mjs
- specsplit.mjs
- track-ref-pathological.json
- track-ref-pathological.mjs
- build.test.mjs
- types.cts
- types.mts
- commonmark.test.mjs
- bad.txt
- good.txt
- spec.txt
- commonmark_extras.txt
- fatal.txt
- linkify.txt
- normalize.txt
- proto.txt
- smartquotes.txt
- strikethrough.txt
- tables.txt
- typographer.txt
- xss.txt
- markdown-it.test.mjs
- misc.test.mjs
- pathological.test.mjs
- ruler.test.mjs
- token.test.mjs
- utils.test.mjs
- helpers.mjs
- .editorconfig
- .gitattributes
- .gitignore
- CHANGELOG.md
- CONTRIBUTING.md
- eslint.config.mjs
- LICENSE
- package-lock.json
- package.json
- README.md
- tsconfig.json
- typedoc.config.mjs
# Installation Guide
nodeSetup Steps
npm install
Install the project dependencies.
npm test
Run the project test suite.
Key Commands
npm install
Install project dependencies specified in package.json.
npm test
Run tests to verify the parser implementation.
# Use via CDN
jsDelivrjsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.
Command Glossary
Commands referenced in this DOCs, explained below.
npm install
View Details ▼
npm install
Install Node packages.
npm {{[i|install]}}
Install dependencies listed in `package.json`:
npm {{[i|install]}} {{package_name}}@{{version}}
Download a specific version of a package and add it to the list of dependencies in `package.json`:
npm {{[i|install]}} {{package_name}} {{[-D|--save-dev]}}
Download the latest version of a package and add it to the list of dev dependencies in `package.json`:
