跳转至

参考

DocsForge Markdown 扩展和组件的完整语法参考。

概述

DocsForge 使用强大的语法扩展了标准 Markdown。所有扩展都在入门模板中默认启用。

  •   提示框

    Note、warning、tip、danger 和自定义标注框。

  •   注释

    为代码块添加注释和说明。

  •   代码块

    语法高亮、行号、标题、复制按钮等。

  •   内容标签页

    使用标签页界面分组相关内容。

  •   数据表格

    可排序、带样式、支持对齐和格式化的表格。

  •   图表

    Mermaid.js 流程图、时序图等。

  •   格式化

    高亮、下标、上标和行内格式化。

  •   图标与表情

    通过 :material-heart: 语法使用 8,000+ 图标和 3,000+ 表情。

  •   图片

    标题、对齐、懒加载和图形标记。

  •   列表

    有序列表、无序列表、嵌套列表、任务列表和定义列表。

  •   工具提示

    缩写、定义和悬停工具提示。

默认启用的 Markdown 扩展

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

标准 Markdown

DocsForge 支持所有标准 Markdown 语法：

  • 标题（# 到 ######）
  • 段落和换行
  • 加粗（**text**）和斜体（*text*）
  • 删除线（~~text~~）
  • 链接（[text](url)）和图片（![alt](url)）
  • 引用块（> quote）
  • 行内代码（`code`）和代码块
  • 水平分隔线（---）
  • 有序和无序列表

下一步

从上方选择一个参考页面，查看详细语法和示例。