blear.classes.markdown

1Introduction

2Example

var Markdown = require('blear.classes.markdown');

自定义 markdown 渲染器。

3Static

3.1.defaults

默认配置。

3.2.defaults.html

  • 类型：Boolean
  • 说明：是否支持渲染 markdown 里的 html
  • 默认：false

3.3.defaults.langPrefix

  • 类型：String
  • 说明：pre 标签的语言类前缀
  • 默认：lang-

3.4.defaults.highlight

4new Markdown(options)

本身是一个方法

4.1options

默认值为 .defaults。

5Prototype

5.1#use(plugin, [options]): this

使用插件，支持 markdown-it 模块的插件。目前内置的插件有：

var markdown = new Markdown();

// h1 - h6 标题生成锚点，通常和 toc 配合使用
markdown.use(require('blear.classes.markdown/plugins/anchor'));

// 生产目录，通常和锚点配合使用
markdown.use(require('blear.classes.markdown/plugins/toc'));

// 块级代码显示行号
markdown.use(require('blear.classes.markdown/plugins/highlight-lines'));

// 支持指定图片尺寸 ![](url =100x200)，其中 `=100x200` 表示图片宽 100，高 200
markdown.use(require('blear.classes.markdown/plugins/image-size'));

// 链接显示收藏图标
markdown.use(require('blear.classes.markdown/plugins/link-favicon'));

// 对提及的字符处理成链接
markdown.use(require('blear.classes.markdown/plugins/mention'));

5.1.1plugin

  • 类型：Function
  • 说明：插件函数
var markdown = new Markdown();

markdown.use(function(md, options) {
    // md 是 markdown 实例
    // options 就是 {a: 1, b: 2}
}, {
    a: 1,
    b: 2
});

5.1.2options

  • 类型：Object
  • 说明：插件的配置项

5.2#render(markdown): html

渲染 markdown 为 html。

5.2.1markdown

  • 类型：String
  • 说明：markdown 内容

5.2.2html

  • 类型：String
  • 说明：html 内容

6Dependencies

7Reference