项目 Wiki

产品功能介绍

Wiki 是一个应交流需要,可随时进行“增删改”的知识库,可用于记录整个项目的来龙去脉,展示当前项目状态,也可让项目成员更好地进行文档书写及协作。CODING Wiki 支持 Markdown 格式、版本控制、新旧版本对比、无限层级拓展等功能,同时还可以通过公开分享链接,达到让非项目成员阅读访问 Wiki 的效果。

产品功能设置

  1. 访问 Wiki 、编辑 Wiki 、删除 Wiki 、分享 Wiki 四项权限需由项目管理员开启。

  2. 仅 Wiki 创建者及项目管理员拥有删除 Wiki 的权限。

创建&编辑 Wiki

  1. 首次使用 Wiki,在任一项目中点击【文件管理】->【Wiki】进入欢迎页,点击【创建第一个页面】。

  1. 在创建页面,可对标题和内容进行编辑。

对于已有的页面,点击【编辑文档】即可进入编辑模式。

开启实时预览

点击全屏按钮,即可进入实时预览的编辑模式。

MD 语法支持

  1. CODING Wiki 支持 MD 语法,您可以在 Wiki 编辑页面点击问号按钮,查看具体的 MD 语法。

  1. CODING Wiki 也支持 mermaid 语法。

更多 mermaid 语法,您可以查看 mermaid 官方帮助文档

Wiki 目录

  1. 选中任意 Wiki ,在左侧的工作区中选择想要修改的文档,选择【新建子页面】选项,在新页面输入标题和正文后即可完成子页面的创建。

  1. Wiki 支持无限层级目录,可拖动任意一层目录,以改变目录的顺序及层级。

Wiki 分享

  1. 点击需要分享的 Wiki 文档,在 Wiki 详情页面点击【分享】按钮。

  1. 开启分享按钮,即可获得此 Wiki 的分享链接。您可以选择公开或加密链接,并且还可以选择是否将子页面一起分享。需要注意的是,如果主页面已选择将子页面分享,则无论子页面是否设置了分享,都会跟随主页面的分享状态。

Wiki 历史版本

  1. 在 Wiki 详情页面点击右上方的菜单按钮,即可查看 Wiki 历史版本。

  1. 选择任一的 Wiki 历史版本,点选相应的功能菜单即可实现对应的操作。

Wiki 回收站

  1. 您可以拖拽不需要的 Wiki 至回收站完成删除操作。需要注意的是,在回收站的文件将保留 30 天,随后将会永久删除,请审慎进行该项操作。

  1. 将会通过列表视图展示回收站的文档。如果删除的 Wiki 中包含子文档,则仅会在回收站中显示主目录文档。

文档是否对您有用?
感谢反馈有用
感谢反馈没用