API 文档

// node.js
// 对于 CJS 可以使用 require('markdown-it')
import markdownit from 'markdown-it'
const md = markdownit()  // 创建 markdown-it 实例
const result = md.render('# markdown-it rulezz!');  // 渲染 markdown 内容

// 浏览器中使用 UMD 构建（脚本加载后添加到 window 对象）
// 注意：名称中没有短横线 "markdownit"
const md = window.markdownit();  // 通过全局对象使用
const result = md.render('# markdown-it rulezz!');  // 渲染结果

import markdownit from 'markdown-it'
const md = markdownit()
// 渲染单行内联内容（不自动包裹段落标签）
const result = md.renderInline('__markdown-it__ rulezz!');

import markdownit from 'markdown-it'

// Commonmark 模式
const md = markdownit('commonmark')

// 默认模式
const md = markdownit()

// 启用所有功能
const md = markdownit({
  html: true,       // 允许源文件中的 HTML 标签
  linkify: true,    // 自动转换类似 URL 的文本为链接
  typographer: true // 启用排版美化功能
})

// 完整选项列表（默认值）
const md = markdownit({
  html: false,          // 是否允许源文件中的 HTML 标签
  xhtmlOut: false,      // 是否使用 '/' 闭合单标签（如 <br />）
  breaks: false,        // 是否将段落中的换行符转换为 <br>
  langPrefix: 'language-', // 围栏代码块 CSS 类前缀
  linkify: false,       // 是否自动转换 URL 文本为链接
  typographer: false,   // 是否启用排版替换和引号美化
  quotes: '“”‘’',       // 启用排版时的双引号/单引号替换对
  // 语法高亮函数。返回转义后的 HTML 或空字符串
  highlight: function (str, lang) {
    if (lang && hljs.getLanguage(lang)) {
      try {
        return hljs.highlight(str, { language: lang }).value;
      } catch (__) {}
    }
    return ''; // 使用外部默认转义
  }
});

import markdownit from 'markdown-it'

// 链式调用 use() 方法加载插件
const md = markdownit()
  .use(plugin1)          // 加载插件1
  .use(plugin2, opts, ...) // 加载插件2并传参
  .use(plugin3);         // 加载插件3

import markdownit from 'markdown-it'
import hljs from 'highlight.js' // 引入 highlight.js

// 实际使用的高亮函数
const md = markdownit({
  highlight: function (str, lang) {
    if (lang && hljs.getLanguage(lang)) {
      try {
        // 使用 highlight.js 进行高亮处理
        return hljs.highlight(str, { language: lang }).value;
      } catch (__) {}
    }
    return ''; // 使用外部默认转义
  }
});

import markdownit from 'markdown-it'
import hljs from 'highlight.js'

// 自定义包装器（可控制 <pre>/<code> 的类名）
const md = markdownit({
  highlight: function (str, lang) {
    if (lang && hljs.getLanguage(lang)) {
      try {
        // 返回完整包装的 HTML 结构
        return '<pre><code class="hljs">' +
               hljs.highlight(str, { language: lang, ignoreIllegals: true }).value +
               '</code></pre>';
      } catch (__) {}
    }
    // 默认转义处理
    return '<pre><code class="hljs">' + md.utils.escapeHtml(str) + '</code></pre>';
  }
});

md.linkify.set({ fuzzyEmail: false });  // 禁用将电子邮件转换为链接

import markdownit from 'markdown-it'

// 通过柯里化启用/禁用规则
const md = markdownit()
  .disable(['link', 'image'])  // 禁用链接和图片规则
  .enable(['link'])            // 重新启用链接规则
  .enable('image');            // 启用图片规则

// 启用所有功能
const md = markdownit({
  html: true,
  linkify: true,
  typographer: true,
});