如何在Linux系统中使用GitHub Flavored Markdown?


Markdown是一种流行的轻量级标记语言,允许用户使用易于阅读和编写的纯文本格式进行写作,然后可以将其转换为HTML或其他格式。本质上,它简化了文本结构和格式化的过程。GitHub Flavored Markdown (GFM)是GitHub使用的Markdown变体,包含帮助开发人员记录其工作的附加功能。

在本文中,我们将深入探讨如何在Linux系统上使用GitHub Flavored Markdown,并提供实际示例及其输出。

GitHub Flavored 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或路径

![GitHub Logo](/images/logo.png)

代码 − 要插入代码,请使用反引号 (`)。对于内联代码,使用单个反引号,对于代码块,使用三个反引号 −

`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工具在Web浏览器中查看Markdown文件。可以使用pip安装它 −

pip install grip

然后,要查看文件,请导航到包含该文件的目录并运行 −

grip yourfile.md

Grip将呈现Markdown文件,你可以通过在浏览器中打开localhost:6419来查看它。

更多关于GitHub Flavored Markdown

虽然我们已经讨论了基本功能和GFM引入的一些附加元素,但让我们深入了解一些更有用的功能,这些功能使GitHub上的文档编写变得轻而易举。

自动链接URL − GFM会自动将URL视为链接,这在普通Markdown中并非如此。它节省了将URL包装在 []() 中以创建链接的时间。

http://www.github.com/

删除线 − GFM添加了删除文本的语法,这在普通Markdown中不可用。这可以通过用双波浪线 ~~ 包装文本来实现。

~~This text will be strikethrough~~

表情符号 − 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 Flavored 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是一个易于使用的CLI Markdown演示文稿编写器。

npm install --global @marp-team/marp-cli

结论

在本文中,我们介绍了在Linux中使用GitHub Flavored Markdown的基础知识,并提供了每个功能的示例和解释。GFM为标准Markdown添加了一些有用的额外功能,使其成为软件文档的绝佳选择。无论你是记录代码还是在博客中写作,Markdown都是你武器库中一个方便的工具。

更新于:2023年7月17日

166 次浏览

启动你的职业生涯

通过完成课程获得认证

开始
广告
© . All rights reserved.