Skip to content

程式區塊的使用

Zensical 中,你可以使用 code blocks(程式區塊) 來顯示程式碼,並且支援 行號、語法高亮、標題 等功能。寫法與 Material for MkDocs 相同。

基本用法

Markdown 本身就有基本的 syntax highlighting。

原始程式

```python
print("Hello, Zensical!")
```

輸出結果

print("Hello, Zensical!")

Zensical 會根據語言自動加上語法高亮!

進階功能

顯示行號(Line Numbers)

原始程式

```python linenums="1"
print("這是第一行")
print("這是第二行")
print("這是第三行")
```

輸出結果

1
2
3
print("這是第一行")
print("這是第二行")
print("這是第三行")

使用 linenums 來顯示行號!

高亮特定行數(Highlight Lines)

原始程式

```python hl_lines="1-2"
print("這行會被高亮")
print("這行也會被高亮")
print("這行不會")
```

輸出結果

print("這行會被高亮")
print("這行也會被高亮")
print("這行不會")

使用 hl_lines="1-2" 來高亮 1-2 行!

添加標題(Title)

原始程式

```python title="example.py"
print("這是 example.py 的內容")
```

輸出結果

example.py
print("這是 example.py 的內容")

使用 title="example.py" 來顯示標題!


隱藏複製按鈕

請先在 zensical.toml 啟用複製按鈕:

[project.theme]
features = [
  "content.code.copy",
]

原始程式

``` {.python .no-copy}
print("這是 example.py 的內容")
print("這行會被高亮")
```

輸出結果

print("這是 example.py 的內容")
print("這行會被高亮")

使用 {.no-copy} 來隱藏「複製」按鈕!

行內程式碼

如果只要在行內顯示程式碼,可以使用:

原始程式

內嵌 `print("Hello, Zensical!")` 在文字裡面!

輸出結果

內嵌 print("Hello, Zensical!") 在文字裡面!

📌 如果要 highlight 內嵌的程式,則使用 #! 加上程式語言的簡碼。請先啟用 pymdownx.inlinehilite

原始程式

內嵌 `#!python print("Hello, Zensical!")` 在文字裡面!

輸出結果

內嵌 print("Hello, Zensical!") 在文字裡面!

總結

功能 語法範例
基本程式碼區塊 ```python print("Hello") ```
顯示行號 ```python linenums="1" ```
高亮特定行 ```python hl_lines="2" ```
添加標題 ```python title="example.py" ```
隱藏複製按鈕 ```{.python .no-copy} ```
行內程式碼 `print("Hello")`

參考資料