文章编辑与发布

文章编辑与发布

本文详细介绍 M-Doc 中文章的编辑、发布和管理功能。


文章状态

每篇文章有两种状态:

状态 说明 可见性
📝 草稿(Draft) 正在编辑中的内容 仅编辑者可见
✅ 已发布(Published) 正式发布的内容 所有有权限的用户可见

Markdown 编辑

M-Doc 使用 Markdown 格式编写内容,支持以下语法:

基本语法

  • 标题(# H1 ~ ###### H6
  • 加粗(**bold**)、斜体(*italic*
  • 有序列表、无序列表
  • 链接([text](url)
  • 图片(![alt](url)
  • 引用(> quote
  • 分隔线(---

扩展语法

  • 代码块:支持语法高亮(Prism.js)
  • 表格:标准 Markdown 表格
  • Mermaid 图表:流程图、时序图、甘特图等
  • 数学公式:LaTeX 语法

图片上传

编辑器支持直接上传图片:

  • 拖拽图片到编辑器
  • 粘贴剪贴板中的图片
  • 点击工具栏的图片按钮选择文件

支持格式:JPEG、PNG、GIF、WebP、SVG
最大文件大小:50MB

文章树结构

stable_key

每篇文章有一个全局唯一的 stable_key(UUID),这个标识跨版本不变。当你 Fork 一个版本时,文章在新版本中保持相同的 stable_key,便于系统追踪同一篇文章在不同版本中的状态。

层级结构

文章通过 parent_article_id 建立父子关系,支持无限层级嵌套。通过 sort_order 控制同级文章的显示顺序。

发布流程

  1. 编辑内容:在编辑器中修改文章
  2. 预览:切换到预览模式检查渲染效果
  3. 发布:点击「发布」并填写提交说明
  4. 验证:切换到阅读模式确认已发布内容

提交说明规范

建议遵循以下格式:

<类型>: <简要描述>

类型:
- 新增:新增章节或内容
- 更新:修改已有内容
- 修复:修复错误或笔误
- 重构:重新组织内容结构

示例:

  • 新增: 添加 API 认证章节
  • 修复: 更正配置参数说明中的错误

AI 自动摘要

文章发布后,系统会自动调用 AI 生成文章摘要(最多 200 字)。摘要用于:

  • 搜索结果展示
  • 文档目录预览
  • SEO 优化