🔨 Markdown 使用总结
Markdown 是什么、能做什么、有哪些好的工具。
是什么
历史、相关规范。
规范/语法 没有统一的标准，工具实现也有差异。
- CommonMark, commonmark/CommonMark, 不包含表格(table)和脚注(footnote)。
- GitHub Flavored Markdown, 简称 GFM，基于 CommonMark，包含扩展的表格，但不包含脚注。相关 Mastering Markdown、Basic writing and formatting syntax。
能做什么
写接口文档、写博客、写书、写幻灯片。
工具
解析 解析 Markdown 的工具。
| 工具 | 语言 | 特点 |
|---|---|---|
| kramdown | Ruby | 提供扩展功能，是 Markdown 的超集 |
| markedjs/marked | JavaScript | |
| markdown-it/markdown-it | JavaScript | 可用插件扩展功能，比如代码高亮 |
编辑软件 独立的 Markdown 应用.
| 工具 | 平台 | 作用 | 特点 |
|---|---|---|---|
| Typora | macOS/Windows/Linux | Markdown 编辑器 | 支持数学公式、流程图；可导出 PDF、HTML |
| Marp | macOS/Windows/Linux | Mardown 写幻灯片 | 可用 Markdown 写幻灯片 |
支持 Markdown 的工具/平台 不是专门的 Markdown 编写工具, 但支持 Markdown.
| 工具 | 平台 | 作用 | 特点 |
|---|---|---|---|
| 有道云笔记 | macOS/Windows/Web/Android/iOS | 笔记应用 | 支持用 Markdown 写笔记 |
| R Markdown | R Package | 报告生成 | Dynamic Documents for R |
| GitHub | Web | 代码托管 | 支持 Markdown 写博客，支持 Markdown 在线预览 |
插件/扩展 Markdown 辅助插件.
| 工具 | 平台 | 作用 | 特点 |
|---|---|---|---|
| markdownlint | Visual Studio Code | Markdown 格式校验提示 | |
| Markdown Here | Chrome/Firefox/Safari/Opera/Thunderbird/Postbox | Markdown 转换 | 支持 Markdown 写邮件，并转换成正常的内容 |
| md-page | 浏览器 | 引入 JS, 在 HTML 页面的 Markdown 语法可直接被解析和查看 | 在 HTML 中编写 Markdown |
md-page 适用于需要网页浏览的文档，可以用来写用户手册或者开发文档，不需要额外的转换。
Markdown 相关的开发工具 与开发相关的, 或者需要编写代码的相关应用.
| 工具 | 平台 | 作用 | 特点 |
|---|---|---|---|
| Postman | macOS/Windows/Linux | API 工具 | 支持 Markdown 写接口文档, 可 mock 数据, 可登录账号管理 API |
| Pandoc | macOS/Windows/Linux/BSD | 文档格式转换 | 支持 Markdown 转换成其他格式（PDF、LaTeX、docx、HTML 等） |
| docsify | Web | Markdown 写文档，然后生成网站 | 适合编写开发文档，并需要网页浏览的情况 |
Markdown 编写建议
-
jekyll 博客代码高亮可用 ruby 的语法高亮, 更简洁的做法如下
console.log("piece of code") -
编写文档, 标题级数太深的情况, 可以尝试用段落替代一级.
### subtitle **paragraph title** paragraph description.