GitHub Wiki - 为你的 Repository 加入文件管理功能

今天我们来谈一点轻松的功能 - GitHub Wiki

身为开发人员,多多少少接触一些文件,可能是与专案管理相关文件:专案规划书、验收文件、操作手册...;也可能是开发团队共同维护的文件:Release SOP 文件、Database Migration 操作文件、纪录服务器相关资讯的文件...。这些文件需要长久被保留,让维运人员或新进开发人员可以藉解专案运作,快速进入状况。所以许多 DevOps 工具也会提供类似Wiki (知识分享协作) 的文件管理功能,当然 GitHub 也不例外。

许多开源专案也会使用 Wiki 作为整个专案的介绍页面教学文件


开始建立 Wiki Page

你能在 Repository 上方功能列中,找到 wiki 按钮。如下图所示,当你没有任何 Wiki Page,可以点选中间 Create the first page 按钮开始新增页面

https://ithelp.ithome.com.tw/upload/images/20210910/20091494KBucjRobOw.png

进入 Create new page,你可以输入页面名称与内容,这里也是使用 markdown 语法进行编辑,您可以在此输入Repo 相关知识,比方说像是人员相关资讯...;下方可以输入变更此 Page 的理由(非必填);输入完成後,点选右下角 Save Page 完成编辑。

https://ithelp.ithome.com.tw/upload/images/20210910/20091494bHa2NoHws5.png

一般来说,对於新的专案,你可以加入一个 Getting Start Page。点选右上角 New Page,按照上一个步骤建立此页面,让大众知道如何使用你的 Repo。

https://ithelp.ithome.com.tw/upload/images/20210910/20091494yMpCG06kci.png

Wiki Page 整体画面相当简显易懂,有点像是部落格,您可以自订侧栏(Sidebar)与底部专栏(footer);正右方是你所有建立的页面;右下角则可以将 Wiki 资讯 clone 至本地端。

https://ithelp.ithome.com.tw/upload/images/20210910/20091494RJ1ccBy37h.png

自订侧栏与顶部专栏部分也是透过 wiki page 组成,命名自动会加上底线。
https://ithelp.ithome.com.tw/upload/images/20210911/20091494Tky8liAqFI.png

依此类推,我们接续的新增侧栏 (Sidebar)
https://ithelp.ithome.com.tw/upload/images/20210911/200914940LZrGYIxAf.png

完成後如下图

随着团队文件越来越多,Wiki 也会越来越丰富,理所当然,良好的分类才能让你的团队成员快速找到想要的文件。

https://ithelp.ithome.com.tw/upload/images/20210911/20091494OQZIhkuZDU.png


Clone Wiki Page

在 wiki 页面右下角,你可以看到一个 Clone this wiki locally,提供了 Git 连结与复制按钮,你可以透过这个连结,使用 Git 工具将 wiki 资讯下载至自己电脑。首先,我们先点选 复制 按钮

记得在你的电脑要安装 Git 才能使用

https://ithelp.ithome.com.tw/upload/images/20210911/200914946HKFE7g5qg.png

开启命令提示字元 (Git CMD 或 Git Bash 也可以),输入 git clone [wiki git 位置],即可复制 wiki page 至目前目录。
https://ithelp.ithome.com.tw/upload/images/20210911/20091494Kse4hLOGus.png

开启资料夹,可以看到所有的 pages (md files)

理所当然,你也能够在本地端编辑,完成後使用 git push 上去
https://ithelp.ithome.com.tw/upload/images/20210911/20091494zle86QjsPj.png


整个 Wiki Page 建立相当简单直觉,无论有没有资讯背景,相信读者们一定都能很快上手。虽然 wiki 只是一个文件、知识管理的功能,但专案没有此功能也挺麻烦的,可能要团队另架网站或寻找现成文件管理服务来进行文件管理。在下一篇文章,我们要开始进入比较有趣的题目: GitHub Action。

若你喜欢我的文章,欢迎订阅与分享。


<<:  [Day 5] Leetcode 322. Coin Change (C++)

>>:  html 改变按钮位子

[Day 12] Reactive Programming - Reactor(publishOn/subscribeOn)

前言 在上一篇介绍了Reactor提供Scheduler来帮助开发者,这篇就是来说明具体是如何使用。...

[Day17] 系统保护策略

在某个我辅导过的团队,我曾观察到一个现象: RD 在评估工作时数,总是会估出不合理的长时间。是 RD...

【Day 2】环境建置 - 安装 VisualStudio 2019

首先要先来跟大家分享我所使用的编译器 — Visual Studio Community,这是一套微...

部署model on seldon(MinIO)

上一篇我们已使用notebook已经将训练好的model上传到MinIO储存空间, 本篇我们将使用s...

Microsoft Azure Pass 学习日志 Day 1

Chap.O Introduce 云端基础 & 简介: Part 1. 云端是什麽,为何要有...