marky-markdown npm 的 markdown 解析器开源项目

我要开发同款
匿名用户2016年08月15日
58阅读
开发技术JavaScript
所属分类开发工具、语法解析工具
授权协议ISC

作品详情

marky-markdown是npm的官方markdown解析器,基于NodeJS编写,旨在用 GitHub-stylemarkdown进行奇偶校验。它由一个最好的 CommonMarkmarkdown解析器——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-markdownmarky-markdown some.md > some.html

它能做什么

Parsesmarkdownwithmarkdown-it,afastandcommonmark-compliantparser.

Removesbrokenandmalicioususerinputwithsanitize-html

AppliessyntaxhighlightingtoGitHub-flavoredcodeblocksusingthehighlightslibraryfromAtom.

UsescheeriotoperformvariousfeatsofDOMmanipulation.

Converts:emoji:-styleshortcutstounicodeemojis.

Convertsheadings(h1,h2,etc)intoanchoredhyperlinks.

ConvertsrelativeGitHublinkstotheirabsoluteequivalents.

ConvertsrelativeGitHubimagessourcestotheirGitHubrawequivalents.

ConvertsinsecureGravatarURLstoHTTPS.

Convertslistitemswithleading[]and[x]intoGitHub-styletasklists

WrapsembeddedYouTubevideossotheycanbestyled.

Parsesandsanitizespackage.descriptionasmarkdown.

AppliesCSSclassestoredundantcontentthatcloselymatchesnpmpackagenameanddescription.

AppliesCSSclassestobadgeimages,sowecandosomethinginterestingwiththemoneday.

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

评论