编写与发布文章

编写与发布文章

文章是 M-Doc 中的最小内容单元。每本文档由多篇文章按树形结构组织。


创建文章

  1. 进入文档页面,选择目标版本
  2. 点击左侧目录区的「新建文章」按钮
  3. 输入文章标题
  4. 可选:选择父文章(用于创建子级层次结构)
  5. 点击「创建」

新创建的文章处于草稿状态,仅作者可见。

编写内容

M-Doc 使用 Markdown 格式编写文章内容,支持:

  • 标准 Markdown 语法(标题、列表、链接、图片、代码块等)
  • 表格
  • 代码高亮(支持多种编程语言)
  • Mermaid 图表
  • 数学公式

在编辑器中编写完内容后,内容会自动保存为草稿。

发布文章

草稿编写完成后,需要发布才能对其他用户可见:

  1. 点击编辑器上方的「发布」按钮
  2. 填写提交说明(类似 Git 的 commit message),描述本次修改内容
  3. 点击「确认发布」

每次发布都会生成一个新的文章版本快照,包含:

  • 提交哈希(commit_hash):40 字符的 SHA1 哈希
  • 提交说明:你填写的修改描述
  • 时间戳:发布时间
  • 作者:发布者信息

这些信息可在文章的「历史记录」中查看。

管理文章树

M-Doc 支持无限层级的文章树结构:

├── 快速开始
│   ├── 安装
│   └── 配置
├── 用户指南
│   ├── 基本功能
│   │   ├── 创建文档
│   │   └── 编辑文章
│   └── 高级功能
└── API 参考
  • 调整排序:拖拽文章标题即可调整顺序
  • 调整层级:拖拽文章到另一篇文章上方,使其成为子文章
  • 删除文章:右键文章标题,选择「删除」

发布后的文章仍然可以继续编辑。每次修改后需要重新发布,修改才会对读者可见。