使用 Github Pages 發布你的專案文件

2022-09-18 06:00:22 字數 1401 閱讀 7276

你可能比較熟悉如何用 github pages 來分享你的工作,又或許你看過一堂教你建立你的第乙個 github pages **的教程。近期 github pages 的改進使得從不同的資料來源來發布您的**更加的方便,其中的**之一就是你的倉庫的 /docs 目錄。

文件的質量是乙個軟體專案健康發展的標誌。對於開源專案來說,維護乙個可靠而不出錯的知識庫、詳細說明所有的細節是至關重要的。精心策劃的文件可以讓增加專案的親切感,提供一步步的指導並促進各種方式的合作可以推動開源軟體開發的協作程序。

在 web 上託管你的文件是乙個消耗時間的挑戰,而且對於它的發布和維護也沒有省事的辦法,然而這是並非不可避免的。面對多種不同的發布工具,又是 ftp 伺服器,又是資料庫,檔案以各種不同的方式存放在不同的位置下,而這些都需要你手動來調整。需要說明的是,傳統的 web 發布方式提供了無與倫比的靈活性和效能,但是在許多情況下,這是以犧牲簡單易用為代價的。

當作為文件使用時,麻煩更少的方式顯然更容易去維護。

github pages 可以以指定的方式為你的專案建立**,這使得它天然地適合發布和維護文件。因為 github pages 支援 jekyll,所以你可以使用純文字或 markdown 來書寫你的文件,從而降低你維護的成本、減少維護時的障礙。jekyll 還支援許多有用的工具比如變數、模板、以及自動**高亮等等,它會給你更多的靈活性而不會增加複雜性,這些你在一些笨重的平台是見不到的。

最重要的是,在 github 上使用 github pages 意味著你的文件和**可以使用諸如 issues 和 pull requests 來確保它得到應有的高水平維護,而且因為 github pages 允許您發布**庫主分支上的 /docs 目錄,這樣您就可以在同一分支同時維護你的**庫及其文件。

現在開始!

發布你的第乙個文件頁面只需要短短幾分鐘。

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

把你的內容以 jekyll 格式新增進去,並提交你的修改。

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

github pages 將會從你的 /docs 目錄中讀取內容,轉換 index.md 為 html。然後把它發布到你的 github pages 的 url 上。

這樣將會建立並輸出乙個最基礎的 html ,而且你可以使用 jekyll 的自定義模板、css 和其他特性。如果想要看所有的可能,你可以看看 github pages showcase。

使用github pages搭建部落格

1.建立乙個 倉庫 登入你的github,點選右上角的 號按鈕,選擇 new repository 開啟建立新倉庫頁面。建立乙個名為為username.github.io的 倉庫,其中username為你的github的賬戶名稱。注 如果username與你的賬戶名稱不匹配,將不會起作用 下圖中因為...

Github Pages 使用國內 CDN 加速

本文以阿里雲cdn github pages coding pages為例 假設你已經建好了繫結了網域名稱的 github pages coding pages 若沒有,則參考該鏈結,請忽略後面新增 cloudflare cdn 的內容 開通阿里雲 cdn 服務,計費方式自己選擇 阿里雲cdn 網域...

GItHub pages 的使用方法

一 基於專案的網頁 在你的乙個repository裡的標籤欄中選擇settings,選擇一種theme。就可以直接通過 訪問了。二 個人網頁 1.新建乙個repository,命名規則為username.github.io 2.本地建立乙個資料夾放你的 用 3.在本地git bash clone u...