just the docs

只是文檔

一個現代、高度可自訂且響應靈敏的 Jekyll 主題，用於帶有內建搜尋的文檔。
輕鬆託管在 GitHub Pages 上，幾乎沒有依賴項。

看看它的實際效果！

各種 Just the Docs 功能的影片演練

只是文檔功能演練.mp4

安裝

使用模板

Just the Docs 範本提供了建立使用 Just the Docs 主題的新網站的最簡單、最快且最簡單的方法。要開始建立網站，只需點擊“使用範本”！

注意：要使用該主題，您不需要複製或分叉 Just the Docs 儲存庫！只有當您打算在本地瀏覽主題文件、為主題的開發做出貢獻或基於 Just the Docs 開發新主題時，才應該這樣做。

您可以輕鬆地將範本建立的網站設定為在 GitHub Pages 上發布 - 範本自述文件解釋瞭如何執行此操作以及其他詳細資訊。

如果您的電腦上安裝了 Jekyll，您也可以在本機建置並預覽已建立的網站。這使您可以在提交更改之前對其進行測試，並避免等待 GitHub Pages。 ¹您將能夠將本地建置部署到 GitHub Pages 以外的平台。

更具體地說，創建的網站：

• 使用基於 gem 的方法，即使用Gemfile並載入just-the-docs gem
• 使用 GitHub Pages / Actions 工作流程在 GitHub Pages 上建立和發佈網站

除此之外，您可以根據自己的喜好自由自訂使用模板建立的網站。您可以輕鬆更改just-the-docs和它使用的 Jekyll 的版本，以及添加更多插件。

使用 RubyGems

或者，您可以將主題安裝為 Ruby Gem，而無需建立新網站。

將此行加入 Jekyll 網站的Gemfile ：

 gem "just-the-docs"

並將此行加入 Jekyll 網站的_config.yml ：

 theme : just-the-docs

然後執行：

 $ bundle

或自己安裝：

 $ gem install just-the-docs

或者，您可以在開發網站時在 Docker 內運行它

 $ docker-compose up

用法

查看文件以取得使用資訊。

貢獻

歡迎在 GitHub 上提交錯誤報告、新功能提案和拉取請求：https://github.com/just-the-docs/just-the-docs。該計畫旨在成為一個安全、溫馨的協作空間，貢獻者應遵守貢獻者契約行為準則。

提交程式碼更改：

• 使用適當的範本提交激發變更的問題
• 與其他使用者和維護者討論建議的更改
• 打開拉取請求
• 確保所有 CI 測試都通過
• 提供檢查更改效果的說明
• 等待代碼審查

本主題設計發展原則：

1. 盡可能少的依賴
2. 無需建置腳本
3. 一流的行動體驗
4. 讓內容閃閃發光

發展

要設定您的環境來開發此主題：fork此儲存庫，從根目錄執行bundle install 。

包含 VSCode 的現代開發容器配置。

您的主題設定就像普通的 Jekyll 網站一樣！若要測試您的主題，請執行bundle exec jekyll serve並在http://localhost:4000開啟瀏覽器。這將使用您的主題啟動 Jekyll 伺服器。像平常一樣添加頁面、文件、資料等來測試主題的內容。當您修改主題和內容時，您的網站將重新生成，刷新後您應該會在瀏覽器中看到更改，就像平常一樣。

當這個主題發佈時，只有 Git 追蹤的_layouts 、 _includes和_sass中的檔案才會包含在 gem 中。

執照

此主題根據 MIT 授權條款作為開源提供。

註腳

1. 將變更推送到 GitHub 後，可能需要長達 10 分鐘才能發布網站的變更。 ↩