创建组织与文档

创建组织与文档

M-Doc 中,文档归属于组织。你需要先创建一个组织,然后在组织下创建文档。


创建组织

  1. 登录后,点击左上角「创建组织」
  2. 填写组织信息:
    • 组织名称:显示名称,如「我的团队」
    • 组织标识(Slug):URL 中使用的唯一标识,如 my-team,仅支持小写字母、数字和连字符
  3. 点击「创建」

创建成功后,你将自动成为该组织的 Owner(所有者),拥有最高管理权限。

邀请成员

组织创建后,可以邀请其他用户加入:

  1. 进入组织设置页面
  2. 在「成员管理」中搜索用户邮箱
  3. 选择角色后点击「添加」

可用角色:

角色 权限
Owner 完全控制,可转让组织
Admin 管理成员和文档
Member 创建和编辑文档
Guest 只读访问

创建文档

  1. 进入目标组织页面
  2. 点击「新建文档」
  3. 填写文档信息:
    • 文档名称:如「产品手册」
    • 文档标识(Slug):URL 中使用的唯一标识,如 product-manual
    • 文档描述:简要说明文档用途
    • 可见性
      • public:所有人可见
      • org:仅组织成员可见
      • private:仅创建者可见
  4. 点击「创建」

文档创建后会自动创建一个默认版本(master),你可以立即开始编写文章。

文档 URL 结构

文档的访问地址遵循以下格式:

https://mdoc.cc/{orgSlug}/{docSlug}

例如:https://mdoc.cc/my-team/product-manual

指定版本时:

https://mdoc.cc/{orgSlug}/{docSlug}/{version}

例如:https://mdoc.cc/my-team/product-manual/v1.0.0