文檔概覽

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`	日期格式。
`navs_border`	boolean	`true`	是否為深層導航顯示左側邊框。
`navs_reduce_font_size`	boolean	`true`	是否縮小子導航的字體。
`navs_sticky_scroll`	boolean	`true`	為 `true` 時，當滾動時，祖先菜單將被固定。

params.toml

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

params.yaml

1params:
2  hb:
3    docs:
4      date_format: :date_long
5      navs_border: true

params.json

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

頁面參數

Name	Type	Default	Description
`comments`	boolean	`true`	是否顯示評論。
`meta`	boolean/object	`true`	为 `false` 时，禁用所有元信息。
`meta.authors`	boolean	`true`	为 `false` 时，禁用作者元信息。
`meta.date`	boolean	`true`	为 `false` 时，禁用日期元信息。
`meta.reading_time`	boolean	`true`	为 `false` 时，禁用阅读时长元信息。
`meta.taxonomies`	boolean	`true`	为 `false` 时，禁用专栏、分类和标签元信息。
`nav_weight`	number	-	文檔導航的權重，若未設置，則按鏈接標題排序。
`nav_icon`	object	-	顯示於文檔導航的圖標。
`nav_icon.vendor`	string	-	圖標提供商。
`nav_icon.name`	string	-	圖標名稱。
`nav_icon.color`	string	-	圖標顏色。
`nav_icon.className`	string	-	圖標 CSS 類名。
`nav_menus`	object	-	額外的外部菜單，僅對欄目有效。
`nav_menus.name`	object	-	額外菜單名稱。
`nav_menus.url`	object	-	額外菜單 URL。
`nav_menus.icon`	object	-	額外菜單圖標。
`redirect`	string	-	外部文檔的 URL。

查看源碼編輯頁面歷史

2024年10月6日星期日 2023年3月31日星期五

社交分享按鈕

瀏覽模塊

文檔概覽

站點參數

頁面參數