npm 的 markdown 解析器 marky-markdown

ISC
JavaScript 查看源码»
跨平台
2016-08-15
局长

marky-markdown 是 npm 的官方 markdown 解析器,基于 NodeJS 编写,旨在用 GitHub-style markdown 进行奇偶校验。它由一个最好的 CommonMark markdown 解析器——markdown-it 构建。

安装

npm install marky-markdown --save

编程中使用

marky-markdown 输出单独函数。为了基本使用,这个函数使用一个由字符串转换而成的参数。

var marky = require("marky-markdown")
marky("# hello, I'm markdown").html()

命令行使用

你可以在 shell 中使用 marky-markdown 来解析 markdown 文件,最简单的方法是全局安装它。

npm i -g marky-markdown
marky-markdown some.md > some.html

它能做什么

  • Parses markdown with markdown-it, a fast and commonmark-compliant parser.

  • Removes broken and malicious user input with sanitize-html

  • Applies syntax highlighting to GitHub-flavored code blocks using the highlights library from Atom.

  • Uses cheerio to perform various feats of DOM manipulation.

  • Converts :emoji:-style shortcuts to unicode emojis.

  • Converts headings (h1, h2, etc) into anchored hyperlinks.

  • Converts relative GitHub links to their absolute equivalents.

  • Converts relative GitHub images sources to their GitHub raw equivalents.

  • Converts insecure Gravatar URLs to HTTPS.

  • Converts list items with leading [ ] and [x] into GitHub-style task lists

  • Wraps embedded YouTube videos so they can be styled.

  • Parses and sanitizes package.description as markdown.

  • Applies CSS classes to redundant content that closely matches npm package name and description.

  • Applies CSS classes to badge images, so we can do something interesting with them one day.

npm 包

var package = {
  name: "foo",
  description: "foo is a thing",
  repository: {
    type: "git",
    url: "https://github.com/kung/foo"
  }
}
marky(
  "# hello, I am the foo readme",
  {package: package}
).html()
的码云指数为
超过 的项目
加载中

评论(0)

暂无评论

暂无资讯

暂无问答

78 款 Markdown 工具

Markable 强大的在线 Markdown 编辑器,支持语法高亮、自动缩进、高亮所在行、显示行数、即时预览。它支持将 HTML 转换成 Markdown。 可以配合 Evernote、Dropbox 使用。 Markdown Here 使用...

2015/06/30 17:00
139
1
Markdown简介

Markdown是什么   Markdown 是一种完全由标点符号标记的纯文本,这些标点符号被Markdown赋予表达含义以使得文本看上去可以代表特定的语义,比如:#井号标记代表标题、*星号标记代表强调、*...

2018/11/12 17:34
14
0
如何在静态页面上使用markdown排版

”Markdown是一种轻量级标记语言,创始人是约翰·格鲁伯(John Gruber)。它允许人们 “使用易读易写的纯文本格式编写文档,然后转换成有效的 HTML 文档。”,转换成html最方便的方式是用插件...

01/11 16:22
18
0
使用MarkDown撰写文档

Markdown 是一种轻量级的「标记语言」,它的优点很多,目前也被越来越多的写作爱好者,撰稿者广泛使用。看到这里请不要被「标记」、「语言」所迷惑,Markdown 的语法十分简单。常用的标记符号...

2016/10/31 10:05
8
0
Markdown文档线下编写工具

Markdown文档,一个在开源平台上流行的文档格式,但其在线编辑也是问题,线下编辑器得各种优缺点又参差不齐,我最近在开源上玩的多了,用Markdown文档也多,现在分享一下我的Markdown文档线下...

2016/11/10 14:57
363
0
Markdown的使用

Markdown tutorial ----------------- 1. markdown语法详见[Markdown快速参考](http://my.oschina.net/ju2ender/blog/100112)、[Markdown快速入门](http://www.oschina.net/question/100267_...

2013/03/29 10:11
293
0
HTML table表格转换为Markdown table表格

举个栗子,当我想要把这个页面的第一个表格转换成Markdown Table时,怎么做更快,效率更高? 只需简单三步,请看示例: 第一步:复制包含HTML table标签的代码 复制table代码(HTML table to...

03/21 14:50
6
0
关于写作那些事之我该选择哪种格式

markdown和富文本 不知道你是否留意过平时写作时的编辑器,有的是 markdown 编辑器,有的是各种富文本编辑器,到底选择哪一个相信你有自己的判断. 如果只是在某一家平台上写作,哪一种编辑器都无...

04/15 22:44
1
0

没有更多内容

加载失败,请刷新页面

返回顶部
顶部