解析markdown之marked

发表于:2017-10-05

之前是用的showdown,发现表格不能解析...

CDN

<script src="https://cdn.bootcss.com/marked/0.3.6/marked.min.js"></script>

npm安装

npm install marked --save

使用marked,node.js环境,浏览器用法类似

一个典型的例子

var marked = require('marked');
var html = marked('markdown语法');
console.log(html);   // 解析后的html

配置项

var marked = require('marked');
marked.setOptions({
  // 他是底层的东西,一般不改,比如 **我是粗体** 解析成<strong>我是粗体</strong>,如果你不满意就可以改变他的结构,比较麻烦。
  renderer: new marked.Renderer(), 

    // 默认:true, 启用Github的风格
  gfm: true,

    // 默认:true,启动表格, 前提必须gfm: true,
  tables: true,

    // 默认:false,启用回车换行,前提必须gfm: true,
  breaks: false,

    // 默认:false,尽可能地兼容 markdown.pl的晦涩部分。不纠正原始模型任何的不良行为和错误。
  pedantic: false,

    // 默认:false,对输出进行过滤(清理),将忽略任何已经输入的html代码(标签)
  sanitize: false,

    // 默认:true,使用比原生markdown更时髦的列表。 旧的列表将可能被作为pedantic的处理内容过滤掉
  smartLists: true,

    // 默认:false,使用更为时髦的标点,比如在引用语法中加入破折号。
  smartypants: false
});
console.log(marked('I am using __markdown__.'));

marked(markdownString [,options] [,callback]) 的3个参数

markdownString   // 必须是字符串,markdown语法
options               // 相当于 marked.setOptions, 看你喜欢那个了
callback              // 回调函数
JavaScript Node.js 编辑器
广告