标准的 Markdown 擅长基础文本格式化,但专业的开发文档需要丰富的结构组件来有效传达复杂的逻辑。docmd 通过一系列同构容器扩展了 Markdown,这些容器可直接渲染为响应式、高保真 UI 元素。

从其他文档引擎迁移?

docmd 开箱即支持 VitePressDocusaurus 的语法别名。:::tip:::warning:::note:::details:::caution 等容器无需修改即可工作。所有容器也支持无空格语法(例如 :::tabs 而不是 ::: tabs)。

块语法参考

所有容器都使用一致的块语法,确保在整个项目中拥有可预测的编写体验。

::: 类型 "可选页眉标题"
这是主要内容区域。
它支持 **Markdown**、图像和深层组件嵌套。
:::
组件 关键字 主要用例
标注 callout 用于技巧、警告和警报的语义化突出显示。
卡片 card 用于功能网格和布局控制的有框结构块。
网格 grids 自动调整的多列结构组。
选项卡 tabs 用于替代平台说明的交互式可切换面板。
步骤 steps 用于“如何操作”指南和教程的视觉数字时间线。
折叠区块 collapsible 用于 FAQ 和深度技术数据的交互式手风琴切换。
按钮 button 自闭合、突出的呼吁操作导航链接。
标签 tag 用于版本、状态或突出的自闭合彩色标签。
英雄区块 hero 具有布局和滑块支持的高影响力落地页部分。
URL 嵌入 embed 用于视频、社交和交互式内容的安全、零延迟嵌入。
变更日志 changelog 结构化、基于时间线的版本历史和发布说明。
嵌套容器 - 用于复杂、多组件布局的递归组合模式。

容器的战略重要性

容器的作用不仅仅是视觉上的点缀;它们向 docmd 引擎和下游 AI 代理提供高保真的 语义信号 (Semantic Signals)

  1. AI 上下文映射:将一个块标记为 callout warning 会明确告诉 LLM 在其推理和生成阶段优先考虑该信息。
  2. 结构完整性:将 cards 与标准 CSS 结合使用,可以在不离开 Markdown 环境的情况下创建复杂的落地页。
  3. 源码可维护性:消除文档源码中的“HTML 臃肿”,保持 .md 文件整洁且机器可读。

递归组合

docmd 支持 无限嵌套深度。你可以在一个容器内组合任何其他容器,纯粹用 Markdown 构建复杂的交互式文档节点。

::: card "架构概览"
    ::: callout info
        此模块利用异步 I/O 流水线。
    :::
    ::: button "深入核心引擎" /advanced/developer-guide
:::

掌握嵌套指南