如何在 Linux 中使用 GitHub 风格的 Markdown？
Markdown 是一种流行的轻量级标记语言，允许用户使用易于阅读和易于编写的纯文本格式进行编写，然后可以将其转换为 HTML 或其他格式。从本质上讲，它简化了文本的结构化和格式化过程。 GitHub Flavored Markdown (GFM) 是 GitHub 使用的 Markdown 的变体，包含帮助开发人员记录其工作的附加功能。
在本文中，我们将通过实际示例及其输出来深入研究如何在 Linux 系统上使用 GitHub Flavored Markdown。
GitHub 风格的 Markdown 基础知识
让我们从 GFM 的基础知识开始。
标题 - 您可以使用“#”字符后跟空格和标题文本来创建标题。使用的“#”字符数对应于标头的级别，从 1（最高）到 6（最低）。例如 -
# Header 1
## Header 2
### Header 3
强调 - 为了强调，您可以将文本设置为粗体或斜体。语法非常简单 -
*This text will be italic*
**This text will be bold**
列表 - 您可以分别使用数字或“*”字符创建有序和无序列表 -
1. First item
2. Second item
* Item
* Another item
链接 - 要创建超链接，请使用方括号作为链接文本，使用括号作为 URL -
[GitHub](http://github.com)
图像 - 要插入图像，请使用感叹号 (!)，后跟方括号中的替代文本以及括号中的图像的 URL 或路径：
代码 - 要插入代码，请使用反引号（`）。对于内联代码，使用单个反引号，对于代码块，使用三个反引号 -
`This is inline code`
这是一个代码块
# GitHub Flavored Markdown (GFM) Extras
While the above examples are common to all Markdown, GFM adds a few useful extras:
1. **Task Lists**: GFM introduces the concept of task lists. These are lists with checkboxes that can be ticked off.
```markdown
- [x] Completed task
- [ ] Incomplete task
表格 - GFM 允许创建简单的表格 -
| Column 1 | Column 2 |
| -------- | -------- |
| Cell 1 | Cell 2 |
语法突出显示 - 使用 GFM，您可以指定代码块的语言以启用语法突出显示。例如 -
```python
def hello_world():
print("Hello, world!")
# Viewing Your Markdown Files
To view your Markdown files on a Linux system, you'll need a Markdown viewer or use an online viewer. For local viewing, you can use applications like "ReText" or "Mark Text". To install ReText, for example, you can use the command:
```bash
sudo apt install retext
您还可以使用grip实用程序在网络浏览器中查看Markdown文件。可以使用 pip 安装 -
pip install grip
然后，要查看文件，请导航到包含该文件的目录并运行 -
grip yourfile.md
Grip 将呈现 Markdown 文件，您可以通过打开 Web 浏览器访问 localhost:6419 来查看它。
有关 GitHub 风味 Markdown 的更多信息
虽然我们已经讨论了 GFM 引入的基本功能和一些附加元素，但让我们深入研究一些更有用的功能，这些功能使在 GitHub 上编写文档和编写变得轻而易举。
URL 自动链接 - GFM 自动将 URL 视为链接，这在常规 Markdown 中不是这种情况。它节省了将 URL 包装在 []() 中以创建链接的时间。
http://www.github.com/
删除线 - GFM 添加了删除文本的语法，这在普通 Markdown 中是不可用的。这可以通过用双波形符 ~~ 包裹文本来实现。
~~This text will be strikethrough~~
Emoji - GFM 支持使用 :EMOJICODE: 形式的表情符号短代码。 GitHub 在此维护了他们支持的表情符号短代码的完整列表。
:smile:
嵌套列表 - 在 GFM 中，您可以通过用四个空格缩进嵌套列表来将一个列表嵌套在另一个列表下。
1. Item 1
1. Sub Item 1
2. Sub Item 2
2. Item 2
引用问题和拉取请求 - GFM 的另一个功能是能够直接使用“#”符号后跟问题或拉取请求编号来引用问题或拉取请求。
See #123 for more details.
用户提及 - GFM 允许您直接提及用户，类似于许多社交平台，使用“@”符号后跟用户名。
Thanks for the contribution, @username!
禁用自动 URL 链接 - 如果您想提及 URL 而不将其自动转换为链接，则可以使用反引号 -
`http://www.github.com/`
更多 Markdown 编辑器
我们提到“ReText”和“Mark Text”作为查看 Markdown 文件的选项。其他值得考虑的好选择包括 -
Typora - 这是一款多功能且时尚的 Markdown 编辑器，支持 Markdown 的实时预览。
Atom - Atom 是 GitHub 开发的文本编辑器。它开箱即用地支持 Markdown，并且可以在分屏中渲染您的 Markdown 文件。
Visual Studio Code - VS Code 内置对 Markdown 的支持。它具有实时预览功能，并且还有许多扩展可用于添加功能。
Ghostwriter - 这是一个无干扰的 Markdown 编辑器，具有干净、简单的界面。
GitHub 风味 Markdown 的高级功能
GitHub Flavored Markdown 不仅限于基础知识。它具有一系列高级功能，可以显着提高文本质量。让我们深入研究这些功能：
块引用 - 这些可用于突出显示文本的重要部分。您可以通过以“>”字符开始一行来创建块引用。
> This is a blockquote.
内联 HTML - 如果 Markdown 语法不太适合您，GFM 允许您将原始 HTML 插入文档中。
<strong>This is bold text</strong>
水平线 - 您可以使用三个连字符、星号或下划线创建水平线。
---
***
___
转义字符 - 在 Markdown 中，某些字符具有特殊含义。如果要按原样显示这些字符，可以在字符前使用反斜杠 '' 对其进行转义。
\*This text will not be italic\*
自动锚 - GFM 自动将 id 属性添加到您的标题中，从而创建锚链接。当您创建目录或需要将读者引导至文档的特定部分时，此功能特别方便。
# Table of Contents
1. [Chapter 1](#chapter-1)
2. [Chapter 2](#chapter-2)
Linux 中的高级 Markdown 工具
这里有一些在 Linux 中处理 Markdown 的更高级的工具 -
Pandoc - 这是一个多功能的文档转换器。它可以转换 Markdown、HTML、LaTeX 和许多其他格式的文档。
sudo apt-get install pandoc
Remark-lint - 如果您想确保您的 Markdown 文件遵循样式指南，您可以使用 Remark-lint，这是一个用 JavaScript 编写的可插入 Markdown linter。
npm install remark-lint
Marp - Marp 是一个 Markdown 演示文稿编写器，具有易于使用的 CLI。
npm install --global @marp-team/marp-cli
结论
在本文中，我们介绍了在 Linux 中使用 GitHub Flavored Markdown 的基础知识，并提供了每个功能的示例和说明。 GFM 在标准 Markdown 的基础上添加了一些有用的附加功能，使其成为软件文档的绝佳选择。无论您是记录代码还是撰写博客，Markdown 都可以成为您的工具库中的便捷工具。