Markdown 资源集
这是一个收集了各种优秀的Markdown资源(库、服务、编辑器、工具、速查表等)的列表。
目录
- Markdown
- Markdown语法扩展
- 手稿
- CommonMark
- GitHub风格的Markdown (GFM)
- 纯味Markdown (VFMD)
- Markdown文档
- Markdown构建模块
- 转换为Markdown的工具
- 书籍服务
- 文章
- 元数据
Markdown
email-style writing for the web by John Gruber and Aaron Swartz
- Markdown (web: daringfireball.net/projects/markdown) - 原始的Markdown语法编写和用Perl编写的处理器,由John Gruber编写;不再维护(最后一次更新于2004年12月)
历史 / 起源
-
Introducing Markdown by John Gruber - 2004年3月15日
我编写了一个名为Markdown的文本到HTML的格式化工具,现已可供下载。
Markdown允许网络写作者使用简单、易读的纯文本格式语法进行写作;
Markdown负责将其转换为有效的XHTML(或者,如果你愿意,也可以是HTML)。 -
Dive into Markdown by John Gruber - 2004年3月19日
你不需要在发送电子邮件之前“预览”它——你写它,你读它,你编辑它,就在那里。
事实上,我非常喜欢写电子邮件。电子邮件是我最喜欢的写作媒介。在过去的五年里,我发送了超过16,000封电子邮件。
平面文本电子邮件的约定使我能够清晰、准确地表达自己,而不会有任何干扰。因此,有了Markdown。网络上的电子邮件风格写作。
-
Markdown by Aaron Swartz - 2004年3月22日
几个月来,我一直在和John Gruber合作一个新项目。这个想法是通过允许你使用几乎相同的语法并自动将其转换为HTML,使编写简单的网页,
特别是博客文章,变得和写电子邮件一样容易。我们从上到下仔细研究了语法细节,试图开发出完美的格式,
我认为我们得到了一个非常棒的结果。我们进行了广泛的测试:在我们的博客上,在我的评论表单中,在我们的电子邮件中。
Markdown语法扩展
- SmartyPants - 将©转换为?,""转换为?等
- Emojis - :octocat:
- CriticMarkup - :octocat:
- GitHub风格的标记 (GFM) - @mention,带[ ]和[x]的待办事项列表等
MultiMarkdown (MMD)
- MultiMarkdown (MMD) - 由Fletcher Penney编写的Markdown扩展,增加了脚注、表格、定义列表、文档元数据(例如标题、作者、日期等)等;首次添加到MultiMarkdown.pl
- 速查表 - 语法快速参考
- 测试套件 :octocat:
- MultiMarkdown.pl :octocat: - 历史上的MultiMarkdown.pl代码;用Perl编写的转换脚本(最后一次更新于2011年1月)
Markdown Extra
- Markdown Extra - 由Michel Fortin编写的Markdown扩展;首次添加到PHP Markdown (Extra)
- Dingus - 在浏览器中尝试Markdown Extra
Markdown Extended (MDE)
- Markdown Extended (MDE) @ aboutmde.org
- 代码 :octocat: - 用PHP编写的转换脚本
手稿
用于Markdown的免费书籍格式
手稿
(web: manuscripts.github.io
,
github: manuscripts
) -
添加book.yml用于书籍(元)信息,例如标题、作者、出版商、年份等。
和contents.yml用于目录和文件结构
- Manuscripts Book Starter Kit (github:
manuscripts/book-starter
)
CommonMark
一个强烈规范、高度兼容的Markdown实现
CommonMark
(web: commonmark.org
)
- 规范 (web:
spec.commonmark.org
) - 由John MacFarlane编辑 - Dingus (web:
spec.commonmark.org/dingus
) - 在浏览器中尝试CommonMark - 讨论 (web:
talk.commonmark.org
) - 代码 (github:
jgm/CommonMark
) - 规范和用JavaScript和C编写的参考代码
GitHub Flavored Markdown (GFM)
CommonMark with GitHub Extensions
GitHub Flavored Markdown (GFM)
- Spec (web: github.github.com/gfm)
- Code (github: github/cmark - reference code in C (fork of cmark w/ extensions)
扩展包括:
Leaf Blocks: 表格 ++
Container Blocks: 任务列表项 ++
Inlines: 删除线;自动链接;禁止原始 HTML
Vanilla Flavored Markdown (VFMD)
A variant of Markdown with an unambiguous specification of its syntax
Vanilla Flavored Markdown (VFMD)
(web: vfmd.org, github: vfmd)
- Spec (web: vfmd.org/vfmd-spec/specification) - Edited by Roopesh Chander
- Code (github: vfmd/vfmd-src) - reference code in C++
不同之处包括:
单词内强调;
引用链接/图片语法简化;
列表和 4 空格规则;
更好的自动链接检测;
双空行作为块的结束;
列表的起始数字;
嵌套结构错误;
包含原始 HTML;
字符编码
Markdown 文档
Markdown 速查表 / 快速参考
Markdown 入门指南 / 教程
Markdown 构建块
Markdown 库 & 工具
Pandoc
(web: pandoc.org, github: github.com/jgm/pandoc) - 一个通用文档转换器(用 Haskell 编写)
kramdown
(web: kramdown.gettalong.org, github: gettalong/kramdown, gem: kramdown) - Markdown 库和命令行工具(用 Ruby 编写)
Markdown Extended (MDE)
(github: e-picas/markdown-extended - 将纯文本输入(字符串或文件)转换为各种输出格式(用 PHP 编写)
marked
(web: marked.js.org, github: marked :octocat:) - 一个 Markdown 解析器和编译器。为速度而构建。(用 Javascript 编写)
markdown-it
(web: markdown-it.github.io, github: markdown-it :octocat:) - Javascript Markdown 解析器。100% CommonMark 支持,扩展,语法插件和高速。
可通过 插件 进行扩展。
concat-md
(npm, github) - CLI 和 API 用于连接 Markdown 文件并根据需要进行修改。还可以从 FrontMatter、文件名和目录名添加标题,降低现有标题的级别以符合添加的标题。
mdcode
(github: mdcode) - Markdown 代码块编写工具。它支持可测试的代码块,实现代码块与源文件之间的双向同步。
Babelmark
- Babelmark 2 - 一个用于比较各种 Markdown 语法实现输出的工具
- Babelmark 2 F.A.Q. - 常见问题(及答案)例如 … ??
Markdown 风格指南 / 最佳实践
待完成
Markdown Lint / 风格规则检查器
- markdownlint - 一个 Node.js 风格检查器和 lint 工具,为 Markdown/CommonMark 文件提供一套良好的默认设置。允许自定义。
- mdformat - CommonMark 兼容的 Markdown 格式化器
- mdlint 待完成
- mdsf - 使用你偏好的代码格式化器来格式化 Markdown 代码片段。
- vscode-markdownlint - Visual Studio Code 插件 启用 markdown 文件的原位 linting。
Markdown Web 组件 / 自定义元素
- Markdown-Tag - 使用 md 标签在任何网站上渲染 Markdown 到 HTML
<x-markdown>
- 待完成
Markdown 转网站 / 博客
Jekyll
(web: jekyllrb.com, github: jekyll/jekyll :octocat:, gem: jekyll