Docs Module

In this section

• Docs Overview

  The docs module provides the basic layouts and templates for docs site, it’s useful for writing project documentation, digital garden, users guides and tutorials.

• Docs Social Share Buttons Module
  Display social share buttons below the docs content.
• Docs Revision Module
  Show revision information below the post content.
• Comments Engine
  • Docs Staticman Comments Module

    This module integrate the Staticman comments module with docs layout.

  • Docs Disqus

    This module adds support for the Disqus comments engine.

  • Docs Emote Comments Engine

    This module adds support for the Emote comments engine.

  • Docs Giscus Comments Engine

    This module adds support for the Giscus comments engine, which powered by GitHub Discussions.

  • Docs Twikoo Module

    This module add support for the Twikoo, a simple, safe and free comments system.

  • Docs Utterances Comments Engine

    This module adds support for the Utterances comments engine, which built on top of GitHub issues.

• Doc Navigation

  The doc nav module generates the menus for navigating to previous and next docs of same sections.

• Docs Breadcrumb

  This module display the breadcrumb for docs layout.

• Docs Content Panel

  This module integrates content panel with blog module.

• Docs Featured Image Module

  This module shows the featured image above the doc content if present.

• Docs Heading Sign

  The heading sign module shows the section sign when hovering on headings.

• Docs Hooks

  The list of docs’s custom hooks.

• Docs Sticky Till The End Module
  By default, the sidebar and ToC (table of contents) will sticky until reach the footer, with this module, they can be sticky all the time.
• Docs ToC Scrollspy Module

  Automatically update table of content navigation to indicate which heading is currently active in the viewport.