如何在 Linux 中使用 GitHub 风格的 Markdown
Markdown是一种为网络创建的格式化语言。Markdown 的目的是让我们在互联网上写作时更加轻松。随着时间的推移,出现了许多版本的 Markdown。但在本文中,我们将主要关注Github Flavored Markdown (GFM)。
Github基于CommonMark。GFM 支持很多附加功能,如表格、代码隔离等。让我们开始探索 GFM 的语法以及如何在不同情况下使用它。
我使用VScode来演示这一点,但你可以选择任何适合你的Linux 编辑器。有些编辑器(如Atom和 Vscode)带有 markdown 支持,而对于某些编辑器,我们需要安装 markdown 插件。
要使用 markdown,文件应该以.md
或.markdown
扩展名保存。
如何向 Markdown 编辑器添加标题
Markdown 支持 6 个级别的标题。要创建标题,请使用 Hash符号,(#)
后跟空格和标题名称。哈希值越高,标题的大小越小。
注意:H1和H2默认具有下划线样式。
# Heading1 ## Heading2 ### Heading3 #### Heading4 ##### Heading5 ###### Heading 6
有时您可能希望将标题居中对齐。但不幸的是,markdown 默认不支持对齐。默认情况下,标题以左对齐呈现。您可以在 markdown 中嵌入 HTML/CSS 标签来实现对齐。
<h1 style="text-align:center">MARKDOWN</h1> <h1 style="text-align:left">MARKDOWN</h1> <h1 style="text-align:right">MARKDOWN</h1> <h1 style="text-align:justify">MARKDOWN</h1>
如何向 Markdown 编辑器添加评论
注释是一种记录某些内容以便更好地理解代码/文档的方式。Markdown 引擎不会呈现这些内容。
<!-- Comment block -->
如何将文本渲染为单行
通常,当您在单独的行中连续输入某些内容时,markdown 会将其呈现为一行。
您可以通过两种方式创建换行符。
- 软断线
- 强硬路线突破
通过在行尾添加两个空格可以创建软换行符。这样 markdown 会将每行渲染为单独的行。
可以通过在每行之间插入一个空行来创建强行中断。
如何添加水平线
水平线可以通过在一行上放置三个或更多星号 (*)、连字符 (-)或下划线 (_)来创建。在它们之间添加空格也是可以的。
* * * --- ___
如何使文本加粗
要使单词或行变为粗体,请将单词或行括在双星号(**)
或双下划线之间(__)
。
**Making this sentence bold using double asterisks.** __Making this sentence bold using double underscore.__
如何使文本变成斜体
要使单词或行变为斜体,请将单词或行括在单个星号(*)
或单个下划线之间(_)
。
*Making this line to be italicized using asterisks.* _Making this line to be italicized using underscore._
如何给线条添加删除线
要删除任何内容,您必须使用双波浪线。将要删除的内容括在双波浪线之间(~~)
。
I am just striking the word ~~Howdy~~. ~~I am striking off the entire line.~~
如何添加区块引用
使用大于号符号(>)
作为块引用。
> Single line blockquote.
看看下面的引用块是如何呈现的。这两行都呈现在同一行中。
> first line > Second line > Third line > Fourth line
您可以使用换行符,在每行末尾留两个空格。这样,每行就不会渲染成一行。
让交替行保持空白,并以大于号作为前缀。这样,您可以在同一个块内的每一行之间创建换行符。
> first line > > Second line > > Third line > > Fourth line
您还可以通过添加两个大于号来创建嵌套块引用(>>)
。
创建内联代码
使用BACKTICK来创建内联代码。以下示例演示了如何创建内联代码。查看呈现为内联代码的单词 notes 和 readme。
Markdown is one of the best tools for taking `notes` and creating `readme` files.
添加代码块语法高亮
添加制表符或 4 个空格,然后放置代码以将其呈现为代码块。或者,将代码放在三个反引号之间,以使代码块呈现为代码块。这里要注意的重要功能是语法突出显示。通常,当您将代码放在块内时,不会对其应用任何配色方案。
``` echo "Hello world" ```
现在看同一个例子,颜色方案是自动应用的。这可以通过在三个反引号后添加编程语言名称来实现,这将把颜色方案应用到代码中。
```bash echo "Hello world" ```
示例 Python 代码。
```python def fp(): print("Hello World!!!") fp() ```
示例 SQL 查询。
```sql SELECT MAX(SALARY_EMP) FROM EMPLOYEE_TABLE WHERE SALARY_EMP<(SELECT MAX(SALARY_EMP) FROM EMPLOYEE_TABLE) ```
创建有序和无序列表
Markdown 中,项目可以组织成有序列表和无序列表。要创建有序列表,请添加数字,后跟句点。这里要注意的有趣部分是数字不必是连续的。Markdown 引擎足够聪明,即使我们进行非连续排序,它也能理解它是一个有序列表。
在下面的示例中,您可以看到我创建了一个非连续排序的有序列表(10、15、150),但 markdown 引擎会按正确顺序呈现它。您还可以创建嵌套列表,如图所示。
要创建无序列表,请使用加号、(+)
星号(*)
或破折号(-)
,后跟空格和列表内容。与有序列表类似,您也可以在此处创建嵌套列表。
创建任务列表
这是 GFM 的一个特殊功能。您可以创建一个任务列表,如下图所示。要将任务标记为已完成,您必须添加‘x’
方括号,如图所示。
添加文本链接
要添加链接,请按照以下语法。
[Example](https://example.com "The best site for Linux")
我们将语法分为 3 个部分。
- 要显示的文本– 这是将放置在方括号内的文本([示例])。
- 链接– 您将实际链接放在括号内。
- 标题– 将鼠标悬停在文本上时,将显示链接的工具提示。标题应放在引号内,如图所示。
从下图中您可以看到“ Example ”是我的显示文本,当我单击它时,它会将我重定向到“ Example.com ”。
您还可以通过将链接放在尖括号内来创建链接< >
。
添加图像链接
图片的语法与添加链接类似。要添加图片,请遵循以下语法。
![BrokenImage](https://www.bing.com/th?id=AMMS_ff6f3f7a38b554421b6e614be6e44912&w=110&h=110&c=7&rs=1&qlt=80&pcl=f9f9f9&cdv=1&dpr=1.25&pid=16.1 "Markdown logo")
我们将语法分为 3 个部分。
- 替代文本– 替代文本将放置在方括号(![alt-text])之间。如果图像损坏或无法加载,此文本将与损坏符号一起显示。
- 链接– 在括号内,您将放置图像的实际链接。
- 标题– 将鼠标悬停在图片上时,将显示图片的名称。标题应放在引号内,如图所示。
您还可以创建带有图像的链接。当用户点击图像时,它将被重定向到外部链接。语法保持不变,只有少量修改。使用我们用于在方括号内插入图像的相同语法,然后在括号内插入链接。
[![BrokenImage](https://www.bing.com/th?id=AMMS_ff6f3f7a38b554421b6e614be6e44912&w=110&h=110&c=7&rs=1&qlt=80&pcl=f9f9f9&cdv=1&dpr=1.25&pid=16.1 "Markdown logo")](https://en.wikipedia.org/wiki/Markdown)
创建表
原始版本的 Markdown 不支持表格。这是 GFM 附带的特殊功能之一。让我们一步步看看如何创建表格。
第一部分是创建列名。可以通过用竖线分隔来创建列名(|)
。
| EMPLOYEE_NAME | EMPLOYEE_AGE | EMPLOYEE_ID |
在第二行,使用破折号(-)
和冒号组合(:)
。破折号告诉 markdown 引擎这将被呈现为表格,而冒号决定我们的文本应该居中、左对齐还是右对齐。
| EMPLOYEE_NAME | EMPLOYEE_AGE | EMPLOYEE_ID | |:-------------:|:-------------|------------:| :---: ⇒ Center alignment :--- ⇒ Left alignment ---: ⇒ Right alignment
从第三行开始,你可以开始创建记录。记录之间应以竖线分隔(|)
。
| EMPLOYEE_NAME | EMPLOYEE_AGE | EMPLOYEE_ID | |:-------------:|:-------------|------------:| | Ravi | 30 | 127 | | karthick | 27 | 128 |
从上图可以看出表格渲染正常,第 1 列居中对齐,第 2 列和第 3 列左右对齐。如果你使用的是Vscode,可以使用“ Markdown Table Prettifier ”来整齐地格式化表格。
创建表情符号
GFM 支持多种表情符号。请查看表情符号备忘单。
这就是本文的全部内容。如果您有任何反馈,请在评论部分发表。