文檔模塊

本節內容

• 文檔概覽

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

• 文檔社交分享按鈕模塊
  於文檔正文下方顯示社交分享按鈕。
• 文檔修訂模塊
  於文檔下方顯示修訂信息。
• 文檔內容面板

  該模塊將內容面板集成到博客。

• 文檔目錄滾動監聽模塊

  自動更新內容目錄導航，以指示視口中當前活動的標題。

• 文檔特色圖片

  若存在特色圖片時，其將被顯示在文檔上方。

• 文檔粘性模塊
  默認情況下，側邊欄和目錄會一直粘性到頁腳，有了這個模塊，它們可以一直保持粘性。
• 文檔鉤子

  本文列出文檔模塊的自定義鉤子。

• 文檔導航

  該模塊將於內容下方生成菜單，用於導航到相同欄目的上一篇和下一篇文檔。

• 文檔標題鏈接

  當鼠標懸停於標題上時，該模塊將顯示其錨點鏈接。

• 文檔麪包屑導航

  該模塊爲文檔佈局提供麪包屑導航支持。

• 評論系統
  • 文檔 Staticman 評論模塊

    該模塊將 Staticman 評論模塊集成於文檔佈局。

  • 文檔 Disqus 評論引擎

    該模塊爲文檔模塊提供 Disqus 評論支持。

  • 文檔 Emote 評論引擎

    該模塊為文檔添加 Emote 評論模塊支持。

  • 文檔 Giscus 評論引擎

    該模塊爲博客模塊提供 Giscus 評論引擎支持，其基於 GitHub 討論實現。

  • 文檔 Twikoo 模塊

    該模塊爲 Twikoo 提供支持，其爲一個簡單、安全和免費的評論系統。

  • 文檔 Utterances 評論引擎

    該模塊爲文檔模塊提供 Utterances 評論引擎的支持，其基於 GitHub issues.