Wiki

Wiki 是一个基于网页可支持协作的文档编辑系统,允许团队和项目成员创建、共享和维护文档,以便记录项目的重要信息、指南、教程和任何与项目相关的知识。

通过 Wiki,可以:

  • 版本控制:Wiki 页面的修改历史被记录,可以随时查看和还原到以前的版本
  • 协作编辑:多人可以同时编辑 Wiki 页面,支持协作工作
  • 链接和目录:可以创建内部和外部链接,以及自动生成目录,以方便文档导航

创建 Wiki

登录 GitCode:首先,请确保你已登录到 GitCode 帐户

进入项目:进入你希望创建 Wiki 的项目页面

点击“Wiki”:在存项目导航中,点击“Wiki”选项卡

点击“创建页面”:如果尚未创建 Wiki 页面,点击「创建页面」按钮

编辑页面:在 Wiki 页面上,点击「编辑」按钮以开始编辑页面,使用 Markdown 或富文本编辑器添加文本、图像、链接等内容

保存页面:完成编辑后,点击「保存」按钮以保存页面

编辑和管理 Wiki

编辑页面:在 Wiki 页面上,点击「编辑」按钮以编辑页面,你可以随时对页面进行修改

版本历史:在编辑页面时,你可以点击「历史版本」按钮来查看页面的版本历史

链接页面:在 Wiki 页面中,你可以创建链接到其他页面的超链接,以便在文档之间进行导航

目录:GitCode Wiki 页面会自动从当前 Wiki 页面通过标题自动生成目录(Toc),以帮助用户浏览 Wiki 内容

最佳实践

以下是使用 Wiki 功能的最佳实践:

  • 清晰的结构:保持文档的结构清晰,使用标题和目录帮助用户导航
  • 及时更新:定期更新文档,以确保它们反映项目的最新状态和信息
  • 协作和审查:鼓励团队成员协作编写和审查文档,以确保准确性和完整性