文檔概覽

2023年3月31日 1 分鐘閱讀模塊文檔

本頁內容

文檔模塊爲文檔站點提供了基本的佈局和模板，其對於編寫項目文檔、數字花園、用戶指南、教程等十分實用。

Module	`github.com/hbstack/docs`
Repository	⭐ Please consider giving a star if your like it.
Stars
Version
Used by
Requirements
License
Usage	See how to use modules.

站點參數

Parameter	Type	Default	Description
`date_format`	string	`:date_long`	日期格式。

params.toml

1[params]
2  [params.hb]
3    [params.hb.docs]
4      date_format = ':date_long'

params.yaml

1params:
2  hb:
3    docs:
4      date_format: :date_long

params.json

1{
2   "params": {
3      "hb": {
4         "docs": {
5            "date_format": ":date_long"
6         }
7      }
8   }
9}

Name	Type	Default	Description
`comments`	boolean	`true`	是否顯示評論。
`nav_weight`	number	-	文檔導航的權重，若未設置，則按鏈接標題排序。
`nav_icon`	object	-	顯示於文檔導航的圖標。
`nav_icon.vendor`	string	-	圖標提供商。
`nav_icon.name`	string	-	圖標名稱。
`nav_icon.color`	string	-	圖標顏色。
`nav_icon.className`	string	-	圖標 CSS 類名。
`redirect`	string	-	外部文檔的 URL。