0.1.0 • Published 7 years ago

digo-marked v0.1.0

Weekly downloads
3
License
MIT
Repository
github
Last release
7 years ago

digo-marked

digo 插件:使用 node-marked 编译 Markdown。

安装

npm install digo-marked -g

用法

编译 Markdown 并重命名为 HTML

digo.src("*.md", "*.markdown").pipe("digo-marked");

源映射(Source Map)

本插件不支持生成源映射。

选项

digo.src("*.md", "*.markdown").pipe("digo-marked", {
	tpl: "",			// 生成的 HTML 模板。[1]
	title: true,		// 是否追加标题。如果为字符串则表示标题内容。[1]
	renderer: null,		// 自定义渲染器。具体见:[渲染器](https://github.com/chjj/marked#renderer)。
	highlight: {, 		// 自定义语法高亮语法。 true 或对象则用法 [highlight.js](https://highlightjs.org/) 高亮。或者用法自定义函数,原型为:highlight (code, lang) [1]
		tabReplace: "    ",// 代替 TAB 字符的字符,用于占位缩进。
		useBR: true,	// 是否用法 <br> 换行。
		classPrefix: "",// 生成 CSS 类名前缀。
		languages: ["html", "js", "css"], // 自动分析语法时,指定所有可能出现的语法。
	},
	gfm: true,			// 启用兼容 [GitHub 风格](https://help.github.com/articles/github-flavored-markdown) 的语法。
	tables: true,   	// 是否支持[表格](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#tables)。仅当 gfm 为 true 时有效。
	breaks: false, 		// 是否追加 [换行](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#line-breaks)。仅当 gfm 为 true 时有效。
	pedantic: false, 	// 完全按照 Markdown 标准风格执行。
	sanitize: false, 	// 删除内置 HTML。
	smartLists: true,	// 改进列表。
	smartypants: false, // 改进连接符。
});

1: 此选项由插件提供。

另参考: https://github.com/chjj/marked