marky-markdown

npm 的 markdown 解析器
授权协议 ISC
开发语言 JavaScript
所属分类 开发工具、 语法解析工具
软件类型 开源软件
地区 不详
投 递 者 王高邈
操作系统 跨平台
开源组织
适用人群 未知
 软件概览

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()
  • markdown使用 开始学习编写markdown,如有错误,还请指正,非常感谢! 一, 标题 markdown中标题有6级,几级标题就使用几个 #。 # 一级目录 ## 二级目录 ### 三级目录 #### 四级目录 ##### 五级目录 ###### 六级目录 二,分隔符 markdown中使用三个或三个以上的 -、_、<br>、<hr>等设置分隔符。 --- ___ *** <br> <h

  • 常用标记 上角标、下角标 下角标 如 H2 、 2H 语法:H~2~ 、~2~H 上角标 如 13 、31 语法:1^3^ 、^3^1 H5语法 下角标 如 H2 、 2H 语法:H<sub>2</sub> 、<sub>2</sub>H 上角标 如 13 、31 语法:1<sup>3</sup> 、<sup>3</sup>1 大括号 水果 = { 苹果 橘子 柚子 水果 = \begin{case

  • 欢迎使用Markdown编辑器写博客 本Markdown编辑器使用StackEdit修改而来,用它写博客,将会带来全新的体验哦: Markdown和扩展Markdown简洁的语法 代码块高亮 图片链接和图片上传 LaTex数学公式 UML序列图和流程图 离线写博客 导入导出Markdown文件 丰富的快捷键 快捷键 加粗 Ctrl + B 斜体 Ctrl + I 引用 Ctrl + Q 插入链接

  • 翻译自 https://stackoverflow.com/editing-help 代码和预格式文本 缩进四个空格以创建转义的<pre> <code>块: printf("%d\n", 42); /* what was the question again? */ (pre 元素可定义预格式化的文本。被包围在 pre 元素中的文本通常会保留空格和换行符。而文本也会呈现为等宽字体。<pre>

  • 1. 空格 一个空格大小的表示:&ensp;或&#8194;, 此时只要在相应需要缩进的段落前加上 4个如上的标记即可,注意要带上分号。 两个空格的大小表示:&emsp;或&#8195;, 同理,使用2个即可缩进2个汉字,推荐使用该方式。 不换行空格:&nbsp;或&#160;,使用4个&#160;即可。

  •     声明:本系列博客部分参考更轻松地撰写博客——CSDN-Markdown编辑器吐槽交流、公告:博客Markdown编辑器,带来全新体验两篇文章而来。其中具体使用的视频教程见CSDN Markdown简明教程,具体的博客专栏见CSDN Markdown简明教程。         本MarkDown简介分成啥是MarkDown、为啥MarkDown和如何MarkDown三个部分。   一、啥是M

 相关资料
  • Marky 是个非常棒的 markdown 编辑器,基于: react redux basscss css-mosules ace editor markdown-it 包含以下特性: 共享支持,简单分享 语法高亮 emoji 同步滚动 github 风格的 markdown

  • GitBook 預設使用 Markdown 標記語法。 本章內容僅快速呈現 Markdown 的基本語法與呈現,若需要更詳細的解說,英文資源可以看看發明人的說明: John Gruber's original spec 以及 GitHub 的擴充版 Github-flavored Markdown info page。Markdown.tw 有不錯的中文詳解;想看看俗稱 GFM - GitHub

  • 更改历史 * 2017-11-17 高天阳 标准化文档内容 * 2017-09-08 高天阳 初始化文档 1 历史、现状和发展 Markdown 是一个 Web 上使用的文本到HTML的转换工具,可以通过简单、易读易写的文本格式生成结构化的HTML文档。 Markdown 的目标是实现「易读易写」。 Markdown具有一系列衍生版本,用于扩展Markdown的功能(如

  • markdown 在模板中插入Markdown代码。使用{{# markdown}}Helper很简单: <div class="my-div"> {{#markdown}} # My heading Some paragraph text {{/markdown}} </div> 确保你的markdown缩进正确。

  • Markdown 是一个 Web 上使用的文本到HTML的转换工具,可以通过简单、易读易写的文本格式生成结构化的HTML文档。目前 Stackoverflow 网站使用这种格式来提问。 一个文本实例: ### Header 3 > This is a blockquote. > > This is the second paragraph in the blockquote. > > ## Thi

  • 问题内容: 我目前正在解析XML,但是我不太确定如何解析“消息”的“状态”属性: 这是代码,我切断了所有不必要的内容: 谁能指导我该如何完成? 提前致谢。 问题答案: Node.getAttributes() 如果使用XPATH检索数据,则可以避免遍历。阅读本教程。