blear.classes.markdown

1Introduction

2Example

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

自定义 markdown 渲染器。

3Static

3.1.defaults

默认配置。

3.1.1.defaults.gfm

  • 类型:Boolean
  • 说明:是否为 github 风格,参考 help.github.com
  • 默认:true

3.1.2.defaults.tables

  • 类型:Boolean
  • 说明:是否显示表格
  • 默认:true

3.1.3.defaults.breaks

  • 类型:Boolean
  • 说明:是否显示断行(是否在断行文字后面添加换行符)
  • 默认:false

3.1.4.defaults.pedantic

  • 类型:Boolean
  • 说明:是否非完整匹配模式
  • 默认:false

3.1.5.defaults.sanitize

  • 类型:Boolean
  • 说明:是否过滤 HTML
  • 默认:false

3.1.6.defaults.smartLists

  • 类型:Boolean
  • 说明:是否智能列表
  • 默认:true

3.1.7.defaults.smartypants

  • 类型:Boolean
  • 说明:是否智能修正模式
  • 默认:true

3.1.8.defaults.langPrefix

  • 类型:String
  • 说明:pre 语言前缀
  • 默认:lang-

3.2.marked

导出 marked 原始对象,详细参考底部引用地址。

4new Markdown(options)

本身是一个方法

4.1options

默认值为 .defaults

5Prototype

5.1#renderer(type, renderer): this

自定义渲染模式。支持:

5.1.1"code", (code, lang, escaped)

定义代码块的渲染。如(以下类似,不多举例):

md.renderer('code', function(code, lang, escaped) {
    var options = this.options;
    code = escaped ? code : customerEscape(code);
    return '<pre ' + options.langPrefix + lang + '><code>' + code + '</code></pre>';
});
5.1.1.1code
  • 类型:String
  • 说明:代码
5.1.1.2lang
  • 类型:String
  • 说明:语言
5.1.1.3escaped
  • 类型:Boolean
  • 说明:是否已被转义

5.1.2"blockquote", (quote)

定义引用块的渲染。

5.1.2.1quote
  • 类型:String
  • 说明:引用的内容

5.1.3"html", (html)

定义原始 html 的渲染。

5.1.3.1html
  • 类型:String
  • 说明:html 内容

5.1.4"heading", (text, level, raw)

定义标题的渲染。

5.1.4.1text
  • 类型:String
  • 说明:文本
5.1.4.2level
  • 类型:Number
  • 说明:级别,1-6
5.1.4.3raw
  • 类型:String
  • 说明:原始字符串

5.1.5"hr", ()

定义分割线渲染。无参数。

5.1.6"list", (body, ordered)

定义列表渲染。

5.1.6.1body
  • 类型:String
  • 说明:文本
5.1.6.2ordered
  • 类型:Boolean
  • 说明:是否为有序列表

5.1.7"listitem", (text)

定义列表项目渲染。

5.1.7.1text
  • 类型:String
  • 说明:文本

5.1.8"paragraph", (text)

定义段落渲染。

5.1.8.1text
  • 类型:String
  • 说明:文本

5.1.9"table", (header, body)

定义表格渲染。

5.1.9.1header
  • 类型:String
  • 说明:表格头部
5.1.9.2body
  • 类型:String
  • 说明:表格内容

5.1.10"tablerow", (content)

定义表格行渲染。

5.1.10.1content
  • 类型:String
  • 说明:表格行内容

5.1.11"tablecell", (content, flags)

定义表格单元格渲染。

5.1.11.1content
  • 类型:String
  • 说明:表格单元格内容
5.1.11.2flags
  • 类型:Object
  • 说明:表格单元格标记
5.1.11.3flags.header
  • 类型:Boolean
  • 说明:是否为表格头部单元格
5.1.11.4flags.align
  • 类型:String
  • 说明:表格单元格对齐方式

5.1.12"strong", (text)

定义着重标签渲染。

5.1.12.1text
  • 类型:String
  • 说明:文本

5.1.13"em", (text)

定义倾斜标签渲染。

5.1.13.1text
  • 类型:String
  • 说明:文本

5.1.14"codespan", (text)

定义行内代码渲染。

5.1.14.1text
  • 类型:String
  • 说明:文本

5.1.15"br", ()

定义换行符渲染。

5.1.16"del", (text)

定义倾斜标签渲染。

5.1.16.1text
  • 类型:String
  • 说明:文本

5.1.17"link", (href, title, text, auto)

定义链接渲染。

5.1.17.1href
  • 类型:String
  • 说明:链接地址
5.1.17.2title
  • 类型:String
  • 说明:链接标题
5.1.17.3text
  • 类型:String
  • 说明:链接文本
5.1.17.4auto
  • 类型:Boolean
  • 说明:是否为自动链接(使用 <> 包裹的链接)

5.1.18"image", (href, title, text)

定义图片渲染。

5.1.18.1href
  • 类型:String
  • 说明:图片地址,可以使用尺寸标记,如:
    • ![自动尺寸](http://img.com/abc.png)
    • ![自定义宽度](http://img.com/abc.png =100)
    • ![自定义宽高](http://img.com/abc.png =100x100)
    • ![自定义宽高](http://img.com/abc.png =100X100)

自动宽度

=200

=100x100

5.1.18.2title
  • 类型:String
  • 说明:图片标题
5.1.18.3text
  • 类型:String
  • 说明:图片文本

5.1.19"text", (text)

定义原始文本的渲染。

5.1.19.1text
  • 类型:String
  • 说明:文本内容

5.2#render(markdown): html

渲染 markdown 为 html。

5.2.1markdown

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

5.2.2html

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

6Dependencies

7Reference