Markdown 程式碼語法高亮

對於程式設計師來說,Markdown 最強大的功能之一就是能夠優雅地呈現程式碼。本章將介紹如何撰寫行內程式碼以及具有語法高亮功能的程式碼區塊。

行內程式碼 (Inline Code)

如果你只想在一個段落中提到一個小片段的程式碼(例如:變數名稱或命令),可以使用反引號 (Backticks) ` 將其包圍。

  • 語法:`程式碼內容`
  • 範例:請使用 `git commit` 命令來提交你的變更。
  • 效果:請使用 git commit 命令來提交你的變更。

程式碼區塊 (Code Blocks)

當你需要呈現多行程式碼時,可以使用「圍欄式代碼塊」(Fenced Code Blocks)。

基本語法

使用三個反引號 ``` 包圍整個程式碼區塊。

print("Hello, World!") x = 5

語法高亮 (Syntax Highlighting)

這是最實用的部分!只要在開頭的三個反引號後面加上該語言的名稱(如 python, javascript, html 等),Markdown 就會根據該語言進行著色。

Python 範例

def greet(name):
    print(f"Hello, {name}!")

greet("Alice")

HTML 範例

<!DOCTYPE html>
<html>
<body>
    <h1>這是標題</h1>
</body>
</html>
語法高亮的具體外觀取決於你使用的網站渲染引擎或編輯器主題。在 Hugo 框架中,常見的主題都已經內建了豐富的程式碼配色方案。

縮排式程式碼區塊 (Indented Code Blocks)

雖然較少使用,但在標準 Markdown 中,你也可以透過在每一行開頭輸入至少 4 個空格1 個 Tab 來建立程式碼區塊。

這是一個縮排式的程式碼區塊。
它不支援語法高亮。
如果你想在程式碼區塊中顯示反引號本身,建議使用「圍欄式」語法,這比縮排式更加直觀。

掌握了程式碼高亮,你的技術文件將會看起來非常專業且易於閱讀!下一章我們來學習如何製作表格。