天天看點

Git與GitHub學習筆記(六)使用 Github Pages 管理項目文檔

你可能比較熟悉如何用 Github Pages 來分享你的工作,又或許你看過一堂教你建立你的第一個 Github Pages 網站的教程。近期 Github Pages 的改進使得從不同的資料源來釋出您的網站更加的友善,其中的來源之一就是你的倉庫的 /docs 目錄。 文檔的品質是一個軟體項目健康發展的标志。對于開源項目來說,維護一個可靠而不出錯的知識庫、詳細說明所有的細節是至關重要的。精心策劃的文檔可以讓增加項目的親切感,提供一步步的指導并促進各種方式的合作可以推動開源軟體開發的協作程序。

在你的倉庫的主分支裡建立一個 /docs/index.md 檔案。

Git與GitHub學習筆記(六)使用 Github Pages 管理項目文檔

index.md檔案添加内容,并送出你的修改。

Git與GitHub學習筆記(六)使用 Github Pages 管理項目文檔

檢視你的倉庫的設定分支然後選擇主分支 /docs 目錄,将其設定為 GitHub Pages 的源 ,點選儲存,你就搞定了

GitHub Pages 将會從你的 /docs 目錄中讀取内容,轉換 index.md 為 HTML。然後把它釋出到你的 GitHub Pages 的 URL 上。

選擇一個主題

Git與GitHub學習筆記(六)使用 Github Pages 管理項目文檔

最後搭建成功後的效果圖

Git與GitHub學習筆記(六)使用 Github Pages 管理項目文檔