GitHub Wiki 頁面的添加和設置

時間 2019-11-06

標籤 github wiki 頁面添加設置欄目 Git 简体版

原文原文鏈接

目前你們在 GitHub 上發佈的項目，通常使用 Markdown 來編寫項目文檔和 README.md 等。Markdown 通常狀況下可以知足咱們的文檔編寫需求，若是使用得當的話，效果也很是棒。不過當項目文檔比較長的時候，閱讀體驗可能就不是那麼理想了，這種狀況我想你們應該都曾經遇到過。git

GitHub 每個項目都有一個獨立完整的 Wiki 頁面，咱們能夠用它來實現項目信息管理，爲項目提供更加完善的文檔。咱們能夠把 Wiki 做爲項目文檔的一個重要組成部分，將冗長、具體的文檔整理成 Wiki，將精簡的、概述性的內容，放到項目中或是 README.md 裏。github

一. Wiki 簡介

Wiki 是一種在網絡上開放且可供多人協同創做的超文本系統，由沃德·坎寧安於 1995 年首先開發，這種超文本系統支持面向社羣的協做式寫做，同時也包括一組支持這種寫做。Wiki 站點能夠有多人（甚至任何訪問者）維護，每一個人均可以發表本身的意見，或者對共同的主題進行擴展或者探討。bash

上面這段描述引用自百度百科，嗯，實際上百度百科自己也是一個 Wiki，最著名的 Wiki 大概是是維基百科了吧。markdown

而後 Wiki 頁面效果大概能夠參考 Kingfisher，看起來仍是很是棒的：網絡

二. Wiki 的開啓和關閉

GitHub 項目的 Wikis 功能默認是開啓的，若是你沒有找到 Wiki 選項卡，多是由於該項目關閉了 Wikis 選項，在項目 Setting 中將其選中便可，如圖所示：ide

若是在以後某一天決定再也不繼續使用 Wikis 也能夠經過取消該功能的勾選將其關閉，即便已經添加了 Wiki 頁面也能夠。而且會保存以前的 Wiki 頁面內容，即關閉 Wiki 功能並不會清除內容，還能夠隨時再打開。工具

三. 建立和編輯頁面

GitHub 的 Wiki 頁面在如圖所示選項卡下，默認應該是開啓的，可是是空的，咱們能夠點擊中間那個綠色的 Create the first page 按鈕建立一個頁面。post

若是你沒有找到 Wiki 選項卡，多是由於該項目關閉了 Wikis 選項，在項目 Setting 中將其選中便可，參考上文內容。網站

點擊 Create the first page 按鈕後會進入 Create new page 頁面：ui

從上往下進行介紹，頂部的輸入框是頁面標題；Edit mode 控制編輯頁面的標記語言類型，這裏默認的是 Markdown，支持的類型以下圖所示：

中間的是頁面內容，咱們能夠用 Edit mode 選擇的語法在這裏編寫頁面內容；底部編輯框用來輸入本次編輯保存時的提交信息；編輯完成後點擊 Save Page 按鈕便可保存，唔，保存前能夠先切換到 Preview 選項卡下進行預覽，看一下效果是不是本身想要的。

而後保存咱們新建的頁面，大概會是以下效果：

點擊右上角的 Edit 按鈕能夠對當前頁面進行編輯，也能夠點擊 New Page 按鈕繼續添加新的頁面。

唔，這裏有一點須要注意的是，默認的主頁標題必須爲 Home，若是不存在標題爲 Home 的頁面，切換到項目的 Wiki 選項卡時，會顯示一個全部頁面組成的列表。因此咱們的主頁必須以 Home 爲標題。

目前好像沒什麼內容，感受比較空額，不過不要緊，接下來咱們會一步步完善。

四. 添加頁腳

點擊 Wiki 頁面底部的 Add a custom footer 按鈕，進入新建頁腳頁面，如圖所示：

新建頁腳頁面實際上就是一個普通的 Create new page 頁面，不過標題須要設爲 _Footer 而且不能修改（若是修改了就不會被看成頁腳來處理了）。

咱們能夠參考 Kingfisher 的頁腳代碼，放置多個超連接在這裏供讀者在閱讀完某一頁後快速跳轉到關鍵的章節或頁面去，具體代碼和效果以下：

[Installation](https://github.com/onevcat/Kingfisher/wiki/Installation-Guide) - [Cheat Sheet](https://github.com/onevcat/Kingfisher/wiki/Cheat-Sheet) - [FAQ](https://github.com/onevcat/Kingfisher/wiki/FAQ) - [API Reference](http://onevcat.github.io/Kingfisher/)
複製代碼

固然也能夠放一些奇怪的東西，好比，這樣的：

如上圖所示，點擊頁腳右側的編輯按鈕，就能夠對頁腳進行編輯啦，很方便。

五. 添加側邊欄

點擊右側的 Add a custom sidebar 按鈕能夠添加側邊欄，和頁腳同理，頁面名爲特殊的 _Sidebar：

咱們能夠參考 Kingfisher 的側邊欄實現，代碼和效果以下：

## Getting Started

* [Getting Started with Kingfisher](https://github.com/onevcat/Kingfisher/wiki/Getting-Started-with-Kingfisher)
 * [Install Kingfisher](https://github.com/onevcat/Kingfisher/wiki/Installation-Guide)
 * [Cheat Sheet](https://github.com/onevcat/Kingfisher/wiki/Cheat-Sheet)
* [API Reference](http://onevcat.github.io/Kingfisher/)

## Migration Guide

* [3.0 Migration Guide](https://github.com/onevcat/Kingfisher/wiki/Kingfisher-3.0-Migration-Guide)
* [2.0 Migration Guide](https://github.com/onevcat/Kingfisher/wiki/Kingfisher-2.0-Migration-Guide)

## Communication

* [FAQ](https://github.com/onevcat/Kingfisher/wiki/FAQ)
* [Ask a question](http://stackoverflow.com/search?q=kingfisher)
* [Submit an issue](https://github.com/onevcat/Kingfisher/issues/new)
* [Open a pull request](https://github.com/onevcat/Kingfisher/compare)

## Information

* [Change Log](https://github.com/onevcat/Kingfisher/blob/master/CHANGELOG.md)
複製代碼