文档模块

本节内容

• 文档概览

  文档模块为文档站点提供了基本的布局和模板，其对于编写项目文档、数字花园、用户指南、教程等十分实用。

• 文档社交分享按钮模块
  于文档正文下方显示社交分享按钮。
• 文档修订模块
  于文档下方显示修订信息。
• 评论系统
  • 文档 Staticman 评论模块

    该模块将 Staticman 评论模块集成于文档布局。

  • 文档 Disqus 评论引擎

    该模块为文档模块提供 Disqus 评论支持。

  • 文档 Emote 评论引擎

    该模块为文档添加 Emote 评论模块支持。

  • 文档 Giscus 评论引擎

    该模块为博客模块提供 Giscus 评论引擎支持，其基于 GitHub 讨论实现。

  • 文档 Twikoo 模块

    该模块为 Twikoo 提供支持，其为一个简单、安全和免费的评论系统。

  • 文档 Utterances 评论引擎

    该模块为文档模块提供 Utterances 评论引擎的支持，其基于 GitHub issues.

• 文档标题链接

  当鼠标悬停于标题上时，该模块将显示其锚点链接。

• 文档导航

  该模块将于内容下方生成菜单，用于导航到相同栏目的上一篇和下一篇文档。

• 文档钩子

  本文列出文档模块的自定义钩子。

• 文档面包屑导航

  该模块为文档布局提供面包屑导航支持。

• 文档目录滚动监听模块

  自动更新内容目录导航，以指示视口中当前活动的标题。

• 文档内容面板

  该模块将内容面板集成到博客。

• 文档特色图片

  若存在特色图片时，其将被显示在文档上方。

• 文档粘性模块
  默认情况下，侧边栏和目录会一直粘性到页脚，有了这个模块，它们可以一直保持粘性。