md0 markdown 文档处理器开源项目

我要开发同款
匿名用户2019年06月28日
40阅读
开发技术JavaScriptHTML/CSS
所属分类文件管理器、应用工具
授权协议MIT

作品详情

md0 是一个丑陋的markdown 转html 的工具。

代码

Gitee: https://gitee.com/hyjiacan/md0Github: https://github.com/hyjiacan/md0UsageTryitonline

NodeJSnpminstallmd0varmd0=require('md0')varmarkdown='#title1\n##title2'varoption={codeIndex:true,codeHeight:0,titleAnchor:true,catalog:false}varhtml=md0(markdown,option)console.log(html)

详细用法见项目根目录文件 ./parser.js

Browser<scriptsrc="/path/to/md0.js"></script><linkrel="stylesheet"href="/path/to/md0.css"/><script>varmarkdown='#title1\n##title2'varoption={codeIndex:true,codeHeight:0,titleAnchor:true,catalog:false}varhtml=md0(markdown,option)console.log(html)</script>也可以使用cdn:

<scriptsrc="https://cdn.jsdelivr.com/npm/md0/dist/md0.js"></script>climd0<input-file>[output-file][--title][--code-header[=true]][--code-index[=true]][--code-height[=0]][--title-anchor[=true]][--catalog[=false]][--use-hljs[=false]]input-file要转换的markdown文件路径output-file输出文件路径,不指定时,使用相同文件名输出到与输入同一路径title指定输出文件的title,不指定时使用文件名code-header是否渲染代码块头,默认为truecode-index是否渲染代码行号,默认为truecode-height设置代码块最大高度,单位为像素,设置为0时表示自动调整。默认为0title-anchor是否渲染标题的锚点,默认为truecatalog是否根据标题渲染目录,默认为falseuse-hljs是否使用highlight.js高亮代码块,默认为falseOption名字类型默认值描述codeHeaderBooleantrue是否在代码块上面显示语言codeIndexBooleantrue是否在代码块前面显示行号codeHeightNumber0代码块的最大高度,单位为px,为0表示不限制titleAnchorBooleantrue是否在标题前显示导航锚点catalogBooleanfalse是否生成目录useHljsBooleanfalse是否使用highlight.js高亮代码Featuremd0添加有实用的引用功能,用于块或结构化内容的引用

定义引用块theCode:

&&&theCode引用的内容部分这里面可以写表格|col1|col2|col3||---|---|---||-|-|-|&&&

theCode 是引用的名称,引用名称仅支持 [a-zA-Z_\-0-9]

引用 theCode 块:

|col1|col2|col3||---|---|---||&theCode&|-|-|使用 &theCode& 来将前面定义的引用块引用到表格内。

使用 highlight.js 高亮代码在使用时,需要自行在页面内引入 highlight.js 库以及其样式文件:

<scriptsrc="/path/to/highlight.min.js"></script><linkhref="/path/to/styles/default.min.css"rel="stylesheet">此时,md0.css 需要在 highlight.js 的样式后引入,以使其适应主题

代码高亮配置参考: https://github.com/highlightjs/highlight.js

声明:本文仅代表作者观点,不代表本站立场。如果侵犯到您的合法权益,请联系我们删除侵权资源!如果遇到资源链接失效,请您通过评论或工单的方式通知管理员。未经允许,不得转载,本站所有资源文章禁止商业使用运营!
下载安装【程序员客栈】APP
实时对接需求、及时收发消息、丰富的开放项目需求、随时随地查看项目状态

评论