Markdown 入门指南

Markdown 概述、工作原理以及用途

参考网址

Markdown 入门指南 | Markdown 指南中文版

https://www.markdown.xyz/getting-started/

Markdown 是什么？

Mark是一种轻量级的标记语言，可用于在纯文本文档中添加格式化元素。Markdown 由 John Gruber 于 2004 年创建，如今已成为世界上最受欢迎的标记语言之一。

当你创建 Markdown 格式的文件时，可以在文本中添加 Markdown 语法，以指示哪些单词和短语看起来应该有所不同。

依赖于你所使用的应用程序，你可能无法实时预览格式化的文档。但是没关系。根据 Gruber 的说法，Markdown 的语法被设计为可读性强且不显眼，因此即使 Markdown 文件中的文本未经过渲染也易于阅读。

Markdown 语法的首要设计目标是尽可能易读。基于这个目标，
Markdown 格式的文档能够以纯文本形式原样发布，而不会看起来像被填满了标签
或格式化指令。

为什么要使用Markdown？

• Markdown 处处可用。人们使用它来创建 网站、文档 、便签 、书籍 、演示文稿 、邮件 和 技术文档 。

• Markdown 是可移植的。几乎可以使用任何应用程序打开包含 Markdown 格式的文本文件。如果你不喜欢当前使用的 Markdown 应用程序了，则可以将 Markdown 文件导入另一个 Markdown 应用程序中。这与 Microsoft Word 等文字处理应用程序形成了鲜明的对比，Microsoft Word 将你的内容锁定在专有文件格式中。

• Markdown 是独立于平台的。你可以在运行任何操作系统的任何设备上创建 Markdown 格式的文本。

• Markdown 能适应未来的变化。即使你正在使用的应用程序将来会在某个时候不能使用了，你仍然可以使用文本编辑器读取 Markdown 格式的文本。当涉及需要无限期保存的书籍、大学论文和其他里程碑式的文件时，这是一个重要的考虑因素。

• Markdown 无处不在。例如 Reddit 和 GitHub 等网站都支持 Markdown，许多桌面和基于 Web 的应用程序也都支持 Markdown。

Markdown 工具

• Markdown相关工具

Markdown 相关工具 | Markdown 指南中文版

https://www.markdown.xyz/tools/

• 推荐工具

线上Markdown

Online Markdown Editor - Dillinger, the Last Markdown Editor ever.

https://dillinger.io/

进入其站点就可以开始在左侧窗格中书写了。渲染后的文档在右侧窗格预览。

MarkText 免费开源Markdown工具

下载地址：Releases · marktext/marktext (github.com)

https://github.com/marktext/marktext/releases

Markdown的工作原理

在使用 Markdown 格式书写时，文本内容存储在带有 .md
 或 .markdown
 扩展名的纯文本文件中。那然后呢？你的 Markdown 格式的文件如何转换为 HTML 或可打印的文档呢？

Markdown 应用程序使用一种称为 Markdown 处理器（也通常称为“解析器”或“实现”）的东西将获取到的 Markdown 格式的文本输出为 HTML 格式。此时，可以在 Web 浏览器中查看你的文档，或者将其与样式表组合并打印。你可以在下图看到此过程的直观表示。

注意：Markdown 应用程序和处理工具是两个单独的组件。为了简洁起见，
在下图中，我将它们组合为一个元素（即 “Markdown应用程序”）。

• 使用文本编辑器或 Markdown 专用的应用程序创建 Markdown 文件。该文件应带有 .md
   或 .markdown
   扩展名。

• 在 Markdown 应用程序中打开 Markdown 文件。

• 使用 Markdown 应用程序将 Markdown 文件转换为 HTML 文档。

• 在web 浏览器中查看 HTML 文件，或使用 Markdown 应用程序将其转换为其他文件格式，例如 PDF。

从你的角度来看，该过程将根据你使用的应用程序的不同而有所不同。例如，Dillinger 本质上将第 1-3 步组合到一个单一、无缝的界面中，你要做的就是在左窗格中键入内容，然后转换结果就在右窗格中就神奇地出现了。但是，如果你使用的是其他工具（例如带有静态网站生成器的文本编辑器），则会发现该过程更为明显。

Markdown 有什么用？

网站

Markdown是为web而设计的 。

如果你您正在寻找利用 Markdown 文件创建网站的最简单方法，请试试 blot.im。当你在 Blot 上注册之后，它将会在你的计算机上创建一个 Dropbox 文件夹。你只需将 Markdown 文件拖放到该文件夹中，然后嗖的一声，这些文件就在你的网站上了。再简单不过了。

如果您熟悉 HTML、CSS和版本管理工具，请试试 Jekyll，这是一个广受欢迎的静态网站生成器，它能将 Markdown 文件转换为 HTML 网站。这种方法的优势之一是 GitHub Pages 为 Jekyll 生成的网站提供免费托管服务。如果 Jekyll 不是你的理想之选，你可以在 其它大量可用的静态站点生成器 中选择一个。

如果你想使用内容管理系统（CMS）来支撑你的网站，请试试 Ghost。Ghost 是一个免费的开源博客平台，拥有一个出色的 Markdown 编辑器。如果你是 WordPress 用户，你将很高兴地知道 WordPress.com 上托管的网站都 支持 Markdown 了。自托管的 WordPress 网站可以使用 Jetpack 插件实现对 Markdown 的支持。

文件资料

Markdown 并不具备像 Microsoft Word 这样的文字处理程序的所有功能，但是对于创建基本文件（例如作业和信件）来说已经足够了。你可以使用 Markdown 文档创作工具来创建 Markdown 格式的文档并将其导出为 PDF 或 HTML 格式。PDF 格式是关键，因为一旦有了 PDF 文档，您就可以使用它进行任何操作：打印、通过电子邮件发送或将其上传到网站。

这是我推荐的一些Markdown文档创作工具：

• Mac: MacDown, iA Writer 或 Marked 2

• iOS Android: iA Writer

• Windows: ghostwriter 或 Markdown Monster

• Linux: ReText 或 ghostwriter

• Web: Dillinger 或 StackEdit

笔记

一些支持Markdown的笔记应用程序

• Simplenote 是适用于所有平台的免费、简单的笔记应用程序。

• Notable 是可以在各种平台上运行的笔记应用程序。

• Bear 是适用于 Mac 和 iOS 设备的类似 Evernote 的应用程序。默认情况下，它并不专门针对 Markdown 的，但是你可以启用 Markdown 兼容模式。

• Joplin 是一款保护个人隐私的笔记应用程序。支持所有平台。

• Boostnote 自称是“专为程序员设计的开源笔记应用程序”。

• 
  

书籍

请试试 Leanpub，该服务可将你的 Markdown 格式的文件转换为电子书。Leanpub 以 PDF、EPUB 和 MOBI 文件格式输出你的图书。

演示文稿

信不信由你，你可以将 Markdown 格式的文件转换成演示文稿。用 Markdown 创建演示文稿需要一点时间来适应，但是一旦你掌握了它，你就能体会到比使用 PowerPoint 或 Keynote 之类的应用程序更快、更容易。Remark（GitHub 仓库）和 Cleaver（GitHub 仓库）、Marp （GitHub project） 一样，是一种基于浏览器的、流行的 Markdown 幻灯片工具。如果你使用的是 Mac，并且希望安装一个应用程序来使用的话，请试试 Deckset、Hyperdeck。

邮件

Markdown 编写电子邮件的简便方法：Markdown Here 是一个免费、开源的浏览器扩展程序，可将 Markdown 格式的文本转换为可用于发送的 HTML。

协作

Slack、Discord、Wiki.js 和 Mattermost 都是很好的协作工具。

文档

Markdown 非常适合技术文档。像 GitHub 这样的公司越来越多地转向使用 Markdown 来创建其文档了。

如果你是为产品或服务编写文档，请试试以下的便捷工具：

• Read the Docs 可以将你所开源的 Markdown 文件生成文档网站。只需将你的 GitHub 仓库连接到他们的服务，然后你就可以将内容推送到该仓库中，Read the Docs 会完成其余的工作。他们还为 商业实体提供服务。

• MkDocs 是一个快速、简单的静态站点生成器，专门用于构建项目文档。文档源文件使用 Markdown 编写，并使用一个 YAML 配置文件进行配置。MkDocs 有多个 内置主题，包括移植自 Read the Docs 的文档主题。最新的一个主题是 MkDocs Material。

• Docusaurus 是一个静态网站生成器，专门用于创建文档网站。它支持翻译、搜索和版本控制。

• VuePress 是基于 Vue 构建的静态站点生成器，并针对编写技术文档进行了优化。

• Jekyll 前面已经提到过它了，但它也是将 Markdown 文件生成文档网站的一个不错的选择。如果你选择 Jekyll，请务必试试 Jekyll 文档主题。

Markdown 方言

使用 Markdown 的过程中，最令人困惑的地方是：实际上每个 Markdown 应用程序都实现了稍有不同的 Markdown 语法。Markdown 的这些变体通常被称为 flavors（方言）。掌握你的应用程序所实现的 Markdown 语法是你需要注意的。

其他资源

• John Gruber’s Markdown documentation. Markdown 的创建者编写的原始指南。 

  https://daringfireball.net/projects/markdown/

• Markdown Tutorial. 一个开源网站，你能用浏览器在这个网站上尝试 Markdown。

    https://www.markdowntutorial.com/

• Awesome Markdown. Markdown 工具和学习资源列表。‍

  https://github.com/mundimark/awesome-markdown

• Typesetting Markdown. 这是一个系列教程，介绍了使用 pandoc 和 ConTeXt 对 Markdown 文档进行排版的系统。

   https://dave.autonoma.ca/blog/2019/05/22/typesetting-markdown-part-1

Markdown 语法速查表

基本语法

这些是 John Gruber 的原始设计文档中列出的元素。所有 Markdown 应用程序都支持这些元素。

标题（Heading）

# H1
## H2                                                               
### H3

粗体（Bold）

**bold text**

斜体（Italic）

*italicized text*

引用块（Blockquote）

> blockquote

有序列表（Ordered List）

1. First item    
2. Second item 
3. Third item

无序列表（Unordered List）

- First item                                                     
- Second item                                                  
- Third item

代码（Code）

`code`

分隔线（Horizontal Rule）

---

链接（Link）

[title](https://www.example.com)

图片（Image）

![alt text](image.jpg)

扩展语法

这些元素通过添加额外的功能扩展了基本语法。但是，并非所有 Markdown 应用程序都支持这些元素。

表格（Table）

| Syntax      | Description |     
| ----------- | ----------- |    
| Header      | Title       |   
| Paragraph   | Text        |

代码块（Fenced Code Block）

```   
{  
  "firstName": "John",   
  "lastName": "Smith", 
  "age": 25   
}    
 ```

脚注（Footnote）

Here's a sentence with a footnote. [^1]                          
[^1]: This is the footnote.

标题编号（Heading ID）

### My Great Heading {#custom-id}

删除线（Strikethrough）

~~The world is flat.~~

任务列表（Task List）

- [x] Write the press release                      
- [ ] Update the website                            
- [ ] Contact the media