软件简介

Mdjs 是一个 易用 轻量级的 Javascript 实现的 Markdown 解析器。

可用于Web前端与Node.js开发中

对于目前广泛使用的 Markdown 语法均可解析(包括表格和TOC目录)

Web前端

//方法一
var html = Mdjs.md2html(markdownText);
//方法二
var mdjs = new Mdjs();
var html = mdjs.md2html(markdownText);

Node.js

npm i md-js


//方法一
var Mdjs = require('md-js');
var html = Mdjs.md2html(markdownText);
//方法二
var Mdjs = require('md-js').Mdjs;
var mdjs = new Mdjs();
var html = mdjs.md2html(markdownText);

配置解析选项

var mdjs = new Mdjs();
var html = mdjs.md2html(markdownText, {
    //markdown 文本中表示段落的每行行末都加入 换行标签

    alwaysNewline: false
});

自定义渲染规则

//创建自定义渲染器类
var myRender = new Mdjs.MdjsRenderer();
//配置自定义引用区块的HTML标签
myRender.tag.quote = ['

', '

'],
//配置自定义邮箱部分的 HTML 生成函数
myRender.func.email = function(email){
    return '[' + email + '](mailto:' + email + ')';
};
//自定义链接参考式
myRender.addRefLinkProvider(function(referName) {
    return { url: 'https://github.com/' + referName };
});
var mdjs = new Mdjs(myRender);
var html = mdjs.md2html(markdownText);