文檔概覽

本頁內容

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

Modulegithub.com/hbstack/docs
Repository⭐ Please consider giving a star if your like it.
Stars
Version
Used by
Requirements
License
UsageSee how to use modules.

站點參數

ParameterTypeDefaultDescription
date_formatstring:date_long日期格式。
navs_borderbooleantrue是否為深層導航顯示左側邊框。

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}

頁面參數

NameTypeDefaultDescription
commentsbooleantrue是否顯示評論。
metaboolean/objecttruefalse 时,禁用所有元信息。
meta.authorsbooleantruefalse 时,禁用作者元信息。
meta.datebooleantruefalse 时,禁用日期元信息。
meta.reading_timebooleantruefalse 时,禁用阅读时长元信息。
meta.taxonomiesbooleantruefalse 时,禁用专栏、分类和标签元信息。
nav_weightnumber-文檔導航的權重,若未設置,則按鏈接標題排序。
nav_iconobject-顯示於文檔導航的圖標。
nav_icon.vendorstring-圖標提供商。
nav_icon.namestring-圖標名稱。
nav_icon.colorstring-圖標顏色。
nav_icon.classNamestring-圖標 CSS 類名。
nav_menusobject-額外的外部菜單,僅對欄目有效。
nav_menus.nameobject-額外菜單名稱。
nav_menus.urlobject-額外菜單 URL。
nav_menus.iconobject-額外菜單圖標。
redirectstring-外部文檔的 URL。
razonyang
2024年7月23日 星期二 2023年3月31日 星期五