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工具现在已弃用。您仍然可以查看旧的存储库，并且在此分支上进行了提交。
