如何在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.