GitBook 开源文档平台前端本地搭建指南：新手三步跑通

GitBook 开源文档平台前端本地搭建指南新手三步跑通【免费下载链接】gitbookThe open source frontend for GitBook doc sites项目地址: https://gitcode.com/gh_mirrors/gi/gitbookGitBook 是 GitBook 文档平台的开源前端渲染引擎基于 Next.js 构建可把任意已发布的文档站点渲染到你自己的本地浏览器中。它适合想自建开源知识库文档站、或想参与文档渲染引擎贡献的开发者。项目概览GitBook 文档平台前端能做什么它是什么一套用 TypeScript Next.js 编写的渲染层代码负责把 GitBook 上已发布的文档内容页面、代码块、API 文档、图表、公式等渲染成网页。适合谁想本地预览和改造文档站点外观的开发者以及希望向文档平台生态提交功能、翻译的社区贡献者。核心亮点monorepo 结构主应用位于packages/gitbook/周边能力拆分为多个可独立发布的包如packages/expr/表达式、packages/react-openapi/API 文档渲染、packages/fonts/字体。本地渲染任意已发布站点只要把已发布 GitBook 站点的 URL 拼到本地服务后面就能在本地看到完整页面代码改动即时生效。环境准备清单确认 Node.js 与 Bun 版本工具最低版本安装指引Node.js≥ 22.3安装 LTS 版即可项目根目录带.nvmrc内容为v22.3装好 nvm 后运行nvm use可自动切到匹配版本Bun≥ 1.2.15官方提供的 curl / PowerShell 一行安装脚本执行即可低于 1.2.15 不支持项目的文本版 lockfile两者装好后建议先node -v和bun -v确认版本达标再进入下一步。三步快速上手从克隆到本地启动第 1 步克隆源码git clone https://gitcode.com/gh_mirrors/gi/gitbook cd gitbook⚠️ 注意如果你会把代码对外分发请保持源码仓库公开以符合 GNU GPLv3放到私有仓库则需商业许可。第 2 步对齐 Node 版本并安装依赖nvm use bun installnvm use会读取项目根目录的.nvmrc切到 22.3bun install按 lockfile 一次性装齐所有工作区依赖。第 3 步启动本地开发服务器bun dev该命令通过 turbo 并发启动各工作区首次编译 Next.js 页面需要等几十秒看到编译完成即表示服务就绪。运行预览与常用维护命令本地预览方法预览地址在http://localhost:3000/url/后面拼上任意已发布 GitBook 站点的路径例如http://localhost:3000/url/gitbook.com/docs即可在本地看到该文档站的完整页面、侧边目录与搜索功能。热更新修改代码保存后刷新浏览器即可看到变化无需重启服务。日常维护命令均在项目根目录执行命令作用bun run format用 oxfmt 统一格式化代码bun run lint用 oxlint 做静态检查bun run lint:fix可自动修复bun run typecheck对所有工作区做 TypeScript 类型检查所有提交的 Pull Request 还会经过视觉对比与性能测试防止渲染回归。许可说明与下一步本项目按GNU GPLv3许可发布你可以自由使用、修改但若要分发代码必须同样公开源码私有化部署或闭源分发需获取商业许可。另外官方提醒自行托管渲染层意味着你要自己负责站点可靠性与后续升级跟进。 接下来你可以修改packages/gitbook/src/components/下的组件尝试改变文档站外观或在packages/gitbook/src/intl/translations/目录为界面补一份你熟悉语言的翻译提交你的第一个 Pull Request一起把这个开源文档平台做得更好。【免费下载链接】gitbookThe open source frontend for GitBook doc sites项目地址: https://gitcode.com/gh_mirrors/gi/gitbook创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考