Skip to content

Reference

Complete syntax reference for all DocsForge Markdown extensions and components.

Overview

DocsForge extends standard Markdown with powerful syntax for technical documentation. All extensions are enabled by default in the starter template.

  •   Admonitions

    Note, warning, tip, danger, and custom callout boxes.

  •   Annotations

    Add comments and explanations to code blocks.

  •   Code blocks

    Syntax highlighting, line numbers, titles, copy button, and more.

  •   Content tabs

    Group related content with tabbed interfaces.

  •   Data tables

    Sortable, styled tables with alignment and formatting.

  •   Diagrams

    Mermaid.js flowcharts, sequence diagrams, and more.

  •   Formatting

    Highlight, subscript, superscript, and inline formatting.

  •   Icons & Emojis

    8,000+ icons and 3,000+ emojis via :material-heart: syntax.

  •   Images

    Captions, alignment, lazy loading, and figure markup.

  •   Lists

    Ordered, unordered, nested, task lists, and definition lists.

  •   Tooltips

    Abbreviations, definitions, and hover tooltips.

Markdown extensions enabled by default

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.arithmatex
  - pymdownx.betterem
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.tabbed
  - pymdownx.tasklist
  - pymdownx.tilde

Standard Markdown

DocsForge supports all standard Markdown syntax:

  • Headings (# to ######)
  • Paragraphs and line breaks
  • Bold (**text**) and italic (*text*)
  • Strikethrough (~~text~~)
  • Links ([text](url)) and images (![alt](url))
  • Blockquotes (> quote)
  • Inline code (`code`) and code blocks
  • Horizontal rules (---)
  • Ordered and unordered lists

Next steps

Pick a reference page above for detailed syntax and examples.