# markdown-it ## Install **node.js** ```bash npm install markdown-it --save ``` **browser (CDN):** - [jsDeliver CDN](http://www.jsdelivr.com/#!markdown-it "jsDelivr CDN") - [cdnjs.com CDN](https://cdnjs.com/libraries/markdown-it "cdnjs.com") ## Usage examples See also: - [Development info](https://github.com/markdown-it/markdown-it/tree/master/docs) - for plugins writers. ### Simple ```js // node.js, "classic" way: var MarkdownIt = require('markdown-it'), md = new MarkdownIt(); var result = md.render('# markdown-it rulezz!'); // node.js, the same, but with sugar: var md = require('markdown-it')(); var result = md.render('# markdown-it rulezz!'); // browser without AMD, added to "window" on script load // Note, there is no dash in "markdownit". var md = window.markdownit(); var result = md.render('# markdown-it rulezz!'); ``` Single line rendering, without paragraph wrap: ```js var md = require('markdown-it')(); var result = md.renderInline('__markdown-it__ rulezz!'); ``` ### Init with presets and options (*) presets define combinations of active rules and options. Can be `"commonmark"`, `"zero"` or `"default"` (if skipped). See [API docs](https://markdown-it.github.io/markdown-it/#MarkdownIt.new) for more details. ```js // commonmark mode var md = require('markdown-it')('commonmark'); // default mode var md = require('markdown-it')(); // enable everything var md = require('markdown-it')({ html: true, linkify: true, typographer: true }); // full options list (defaults) var md = require('markdown-it')({ html: false, // Enable HTML tags in source xhtmlOut: false, // Use '/' to close single tags (
). // This is only for full CommonMark compatibility. breaks: false, // Convert '\n' in paragraphs into
langPrefix: 'language-', // CSS language prefix for fenced blocks. Can be // useful for external highlighters. linkify: false, // Autoconvert URL-like text to links // Enable some language-neutral replacement + quotes beautification typographer: false, // Double + single quotes replacement pairs, when typographer enabled, // and smartquotes on. Could be either a String or an Array. // // For example, you can use '«»„“' for Russian, '„“‚‘' for German, // and ['«\xA0', '\xA0»', '‹\xA0', '\xA0›'] for French (including nbsp). quotes: '“”‘’', // Highlighter function. Should return escaped HTML, // or '' if the source string is not changed and should be escaped externaly. // If result starts with `): ```js var hljs = require('highlight.js') // https://highlightjs.org/ // Actual default values var md = require('markdown-it')({ highlight: function (str, lang) { if (lang && hljs.getLanguage(lang)) { try { return '
' +
               hljs.highlight(str, { language: lang, ignoreIllegals: true }).value +
               '
'; } catch (__) {} } return '
' + md.utils.escapeHtml(str) + '
'; } }); ``` ### Linkify `linkify: true` uses [linkify-it](https://github.com/markdown-it/linkify-it). To configure linkify-it, access the linkify instance through `md.linkify`: ```js md.linkify.tlds('.py', false); // disables .py as top level domain ``` ## Syntax extensions Embedded (enabled by default): - [Tables](https://help.github.com/articles/github-flavored-markdown/#tables) (GFM) - [Strikethrough](https://help.github.com/articles/github-flavored-markdown/#strikethrough) (GFM) Via plugins: - [subscript](https://github.com/markdown-it/markdown-it-sub) - [superscript](https://github.com/markdown-it/markdown-it-sup) - [footnote](https://github.com/markdown-it/markdown-it-footnote) - [definition list](https://github.com/markdown-it/markdown-it-deflist) - [abbreviation](https://github.com/markdown-it/markdown-it-abbr) - [emoji](https://github.com/markdown-it/markdown-it-emoji) - [custom container](https://github.com/markdown-it/markdown-it-container) - [insert](https://github.com/markdown-it/markdown-it-ins) - [mark](https://github.com/markdown-it/markdown-it-mark) - ... and [others](https://www.npmjs.org/browse/keyword/markdown-it-plugin) ### Manage rules By default all rules are enabled, but can be restricted by options. On plugin load all its rules are enabled automatically. ```js // Activate/deactivate rules, with curring var md = require('markdown-it')() .disable([ 'link', 'image' ]) .enable([ 'link' ]) .enable('image'); // Enable everything md = require('markdown-it')('full', { html: true, linkify: true, typographer: true, }); ```