gitbook
1.0.0
文檔 - 社區 - 開發人員文檔-ChangElog-錯誤報告
歡迎使用GitBook，該平台用於管理團隊的技術知識。
該存儲庫包含用於渲染GitBook已發佈內容的開源代碼。
入門
貢獻
貢獻的類型
許可
致謝
舊版GitBook
要運行此項目的本地版本，請按照以下簡單步驟操作。
node.js（版本：> = 18.x）
包子
克隆倉庫中的公共github存儲庫。如果您打算分發代碼，請將源代碼公開以遵守GNU GPLV3。要克隆私人存儲庫，請獲得商業許可。
git clone https://github.com/gitbookIO/gitbook.git
確保您使用項目的node版本。運行nvm use將使您的本地版本更改為正確的版本。
通過BUN安裝項目的依賴項。
bun install
啟動您的本地開發服務器。
bun dev
在您的Web瀏覽器中打開已發布的GitBook空間，以http://localhost:3000/ 。
示例：
http：// localhost：3000/docs.gitbook.com
http：// localhost：3000/open-source.gitbook.io/midjourney
任何已發布的GitBook網站都可以通過您的本地開發實例訪問，您對代碼庫進行的任何更新都將反映在您的瀏覽器中。
bun format ：格式代碼
bun lint ：皮棉代碼
所有拉式要求都將針對視覺和性能測試進行測試，以防止回歸。
Gitbook的渲染引擎是完全開源的，並在Next.js的頂部建造。前往我們的貢獻指南，以了解有關添加您的第一個拉動請求的有關工作流程的更多信息。
我們鼓勵您為GitBook做出貢獻，以幫助我們建立記錄技術知識的最佳工具。如果您正在尋找一些快速的貢獻方法，請繼續閱讀以了解更多有關流行貢獻的信息。
GitBook UI是使用packages/gitbook/src/intl/translations中的一組翻譯文件渲染的。我們歡迎UI的所有其他翻譯。
遇到錯誤或找到要解決的問題？幫助我們解決與GitBook相關的問題可大大改善所有人的體驗。轉到此存儲庫的問題部分，以了解有關您已經提供幫助的錯誤類型的更多信息。
警告
雖然可以自我主持這個項目，但是除非您確定此選項適合您的需求，否則我們不建議這樣做。
想要在GitBook中添加特定功能？前往我們的貢獻指南開始。
自我主持這個項目負責維護和合併未來的更新。我們不能保證對該項目的分叉和自託管實例的支持，維護或更新。
我們希望使我們的社區盡可能容易地協作和推動Gitbook的未來，這就是為什麼我們鼓勵您直接為我們的產品做出貢獻，而不是創建自己的版本。
該項目使您可以自助式GitBook發布的內容的渲染部分。自我託管具有利弊。
在Pro方面，您可以自定義內容的外觀和感覺，並更好地將文檔嵌入到應用程序中。
在騙子方面，您對發佈網站的可靠性負責，並使渲染器對GitBook平台的更改保持最新狀態。
根據GNU GPLV3許可證分發。
如果您打算分發代碼，則必須將源代碼公開以遵守GNU GPLV3。要克隆私人存儲庫，請獲得商業許可。
有關更多信息，請參見LICENSE 。
[](https://gitbook.com/)
<a href="https://gitbook.com"><imgsrc="https://img.shields.io/static/v1?message=Documented%20on%20GitBook&logo=gitbook&logoColor=ffffff&label=%20&labelColor=5c5c5c&color=3F89A1 “
/> </a>沒有這些項目，GitBook是不可能的：
next.js
包子
尾風CSS
制定運動
我們以前版本的GitBook及其CLI工具現在已棄用。您仍然可以查看舊的存儲庫，並且在此分支上進行了提交。
