@types/markdown-it

What is @types/markdown-it?

The @types/markdown-it package provides TypeScript type definitions for the markdown-it library, a Markdown parser done right. It enables developers to use markdown-it in TypeScript projects with type checking, enhancing development experience by providing autocompletion and error checking based on the types of the markdown-it API.

What are @types/markdown-it's main functionalities?

Basic Parsing

This feature allows for the conversion of Markdown text into HTML. The code sample demonstrates how to create an instance of MarkdownIt and use it to render a simple Markdown string into HTML.

import MarkdownIt from 'markdown-it';
const md = new MarkdownIt();
const result = md.render('# markdown-it rulezz!');

Custom Renderer

This feature enables customization of the HTML output for specific Markdown elements. In the code sample, the rendering rules for strong (bold) text are modified to use '<b>' tags instead of the default '<strong>'.

import MarkdownIt from 'markdown-it';
const md = new MarkdownIt();
md.renderer.rules.strong_open = () => '<b>';
md.renderer.rules.strong_close = () => '</b>';
const result = md.render('**text**');

Plugin Usage

This feature demonstrates how to extend markdown-it with plugins. The code sample shows the use of the markdown-it-emoji plugin to render emojis within the Markdown text.

import MarkdownIt from 'markdown-it';
import emojiPlugin from 'markdown-it-emoji';
const md = new MarkdownIt();
md.use(emojiPlugin);
const result = md.render(':smile:');

Other packages similar to @types/markdown-it

remark

Remark is an ecosystem of plugins for processing Markdown with JavaScript. It is highly extensible, similar to markdown-it with its plugin system, but built on the unified collective, making it part of a larger ecosystem for processing text.

showdown

Showdown is a JavaScript Markdown to HTML converter, similar to markdown-it in its basic functionality. It emphasizes extensibility and customization through options and extensions, though it might not offer as rich a plugin ecosystem as markdown-it.

marked

Marked is a fast Markdown parser and compiler written in JavaScript. It is designed to be as compatible as possible with the original Markdown spec. Compared to markdown-it, marked focuses on speed and compliance with the original Markdown design, potentially offering less extensibility in terms of plugins.

README

Installation

npm install --save @types/markdown-it

Summary

This package contains type definitions for markdown-it (https://github.com/markdown-it/markdown-it).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/markdown-it/v13.

Additional Details

• Last updated: Thu, 25 Jul 2024 05:07:29 GMT
• Dependencies: @types/linkify-it, @types/mdurl

Credits

These definitions were written by York Yao, Robert Coie, duduluu, and Piotr Błażejewicz.