问题描述
大家在实验室或者开发团队中,需要共享一下最佳实践,包括但不限于代码、工具、资料、操作手册等,便于快速查找资料,也便于新成员快速了解项目组正在做的工作,所以搭建一个团队内部Wiki便成为一个有效的解决之道,有很多开源和商业Wiki产品可以使用,但是,这些Wiki产品要么是付费的,要么需要托管在服务器上,服务器要么租赁,要么自有,服务器的费用是一笔开支,即使不在乎服务器的开支,也要考虑Wiki的访问速度和稳定性,那么有没有一种方法,既不用担心服务器开支又可以确保wiki稳定性及可访问性的解决方案呢?
解决方法
答案是:有,借助代码托管平台的wiki功能,便可以实现一个解决上述两大痛点的团队内部Wiki,下面以国内访问方便的gitee(码云)为例,进行说明。
- 在gitee上新建一个Project
- 添加团队成员到该project,为不同的成员设置不同的权限,防止wiki被随意编辑
- 在project的wiki页面新增page,在不同的page中撰写不同的内容,也可以为同一主题的pages建立一个文件夹,这样便于组织wiki的内容,如下图所示:
- 为wiki中的建立一个主页面,用作对wiki的介绍,并作为其他页面的一个总目录,如上图的新手必读页面。
- 平时可以在preview视图中查阅使用wiki,在上图中点击
preview
按钮,便可得到下图所示的页面,将下图页面的链接作为wiki的访问入口,贡献给团队成员使用即可。
- 由于代码托管平台的空间有限,对于非图文内容,建议使用外部云存储,比如各种网盘,这样做的另外一个好处是,wiki的编辑不涉及git操作,只需要在网页上使用markdown编辑wiki内容即可实现更新,很方便呦。
- 最后一个比较重要的问题是,保持wiki格式和风格的一致,wiki的编辑本质上就是撰写markdown,那么有一个共享的markdown模板就很重要,如上图中的
markdown模板
就是一个供成员在修改wiki时使用的模板。模板如下图所示:
- 最后,博主将该
markdown模板
的源码共享如下,供有需要的读者参考使用:
Wiki Markdown模板源代码
### 写在前面
这是一个Wiki页面模板,包含各种wiki编辑示例操作,编辑页面时可参考该页面的markdown源代码,要查看该页面的源代码,点击页面上的 ***编辑*** 按钮。
***
### 目录
1. [标题示例](#headline)
2. [文字示例](#text)
3. [图片示例](#image)
3.1 [快速插入](#quick)
3.1.1 [三级目录示例(别点我)](#)
3.1.1 [四级目录示例(别点我)](#)
3.2 [居中并带标题](#center)
4. [表格示例](#table)
5. [公式示例](#equation)
6. [插入链接](#link)
7. [文件分享](#share)
***
<a name="headline"/>
### 1. 标题示例
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
<a name="text"