[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"project-3600":3},{"id":4,"name":5,"fullName":6,"owner":7,"repo":5,"description":8,"homepage":9,"htmlUrl":10,"language":11,"languages":10,"totalLinesOfCode":10,"stars":12,"forks":13,"watchers":14,"openIssues":15,"contributorsCount":16,"subscribersCount":16,"size":16,"stars1d":17,"stars7d":18,"stars30d":19,"stars90d":16,"forks30d":16,"starsTrendScore":18,"compositeScore":20,"rankGlobal":10,"rankLanguage":10,"license":21,"archived":22,"fork":22,"defaultBranch":23,"hasWiki":22,"hasPages":24,"topics":25,"createdAt":10,"pushedAt":10,"updatedAt":29,"readmeContent":30,"aiSummary":31,"trendingCount":16,"starSnapshotCount":16,"syncStatus":32,"lastSyncTime":33,"discoverSource":34},3600,"gitbook","GitbookIO\u002Fgitbook","GitbookIO","The open source frontend for GitBook doc sites","https:\u002F\u002Fwww.gitbook.com",null,"TypeScript",28896,4038,681,46,0,3,13,73,89.8,"GNU General Public License v3.0",false,"main",true,[26,27,5,28],"documentation","git","markdown","2026-06-12 04:00:18","\u003Ch1 align=\"center\">GitBook\u003C\u002Fh1>\n\n\u003Cp align=\"center\">\n  \u003Ca href=\"https:\u002F\u002Fgitbook.com\u002Fdocs\u002F\">Docs\u003C\u002Fa> - \u003Ca href=\"https:\u002F\u002Fgithub.com\u002FGitbookIO\u002Fcommunity\">Community\u003C\u002Fa> - \u003Ca href=\"https:\u002F\u002Fdeveloper.gitbook.com\u002F\">Developer Docs\u003C\u002Fa> - \u003Ca href=\"https:\u002F\u002Fchangelog.gitbook.com\u002F\">Changelog\u003C\u002Fa> - \u003Ca href=\"https:\u002F\u002Fgithub.com\u002FGitbookIO\u002Fgitbook\u002Fissues\u002Fnew?assignees=&labels=bug&template=bug_report.md\">Bug reports\u003C\u002Fa> - \u003Ca href=\"https:\u002F\u002Fgithub.com\u002Forgs\u002FGitbookIO\u002Fdiscussions\u002Fcategories\u002Ffeature-requests\">Feature requests\u003C\u002Fa> \n\u003C\u002Fp>\n\n\u003Cp align=\"center\">\n  \u003Ca href=\"https:\u002F\u002Fgitbook.com\">\u003Cimg src=\"https:\u002F\u002Fimg.shields.io\u002Fstatic\u002Fv1?message=Documented%20on%20GitBook&logo=gitbook&logoColor=ffffff&label=%20&labelColor=5c5c5c&color=3F89A1\">\u003C\u002Fa>\n  \u003Ca href=\"#\">\u003Cimg src=\"https:\u002F\u002Fimg.shields.io\u002Fbadge\u002FOpen_Source-❤️-FDA599?\"\u002F>\u003C\u002Fa>\n  \u003Ca href=\"\u002FLICENSE\">\u003Cimg src=\"https:\u002F\u002Fimg.shields.io\u002Fbadge\u002FLicense-GNU_GPLv3-F4E28D\"\u002F>\u003C\u002Fa>\n  \u003Ca href=\"\u002F.github\u002FCONTRIBUTING.md\">\u003Cimg src=\"https:\u002F\u002Fimg.shields.io\u002Fgithub\u002Fcontributors\u002FgitbookIO\u002Fgitbook\"\u002F>\u003C\u002Fa>\n  \u003Ca href=\"https:\u002F\u002Fgithub.com\u002FgitbookIO\u002Fgitbook\u002Fissues\">\u003Cimg src=\"https:\u002F\u002Fimg.shields.io\u002Fgithub\u002Fissues\u002FgitbookIO\u002Fgitbook\"\u002F>\u003C\u002Fa>\n\u003C\u002Fp>\n\n\u003Cp align=\"center\">Welcome to GitBook, the platform for managing technical knowledge for teams.\u003C\u002Fp>\n\n\u003Cp align=\"center\">This repository contains the open source code used to render GitBook's published content.\u003C\u002Fp>\n\n\u003Cp align=\"center\">\n  \u003Cimg alt=\"GitBook Open Published Site\" src=\".\u002Fassets\u002Fpublished-site.png\">\n\u003C\u002Fp>\n\n## Table of Contents\n\n-   [Getting Started](#getting-started)\n-   [Contributing](#contributing)\n    -   [Types of contributions](#types-of-contributions)\n-   [Licensing](#license)\n-   [Acknowledgements](#acknowledgements)\n-   [Legacy GitBook](#legacy-gitbook-deprecated)\n\n## Getting Started\n\nTo run a local version of this project, please follow these simple steps.\n\n### Prerequisites\n\n- Node.js (Version: >= 22.3)\n    - Use nvm for easy Node management\n- [Bun](https:\u002F\u002Fbun.sh\u002F) (Version: >=1.2.15)\n  - We use a text-based lockfile which isn't supported below 1.2.15\n\n### Set up\n\n1. Clone the repo into a **public** GitHub repository. If you plan to distribute the code, keep the source code public to comply with GNU GPLv3. To clone in a private repository, acquire a [commercial license](https:\u002F\u002Fwww.gitbook.com\u002Fpricing).\n\n```\ngit clone https:\u002F\u002Fgithub.com\u002FgitbookIO\u002Fgitbook.git\n```\n\n2. Ensure you are using the project's version of `node`. Running `nvm use` will change your local version to the correct one.\n\n3. Install the project's dependencies through Bun.\n\n```\nbun install\n```\n\n4. Start your local development server.\n\n```\nbun dev\n```\n\n6. Open a published GitBook space in your web browser, prefixing it with `http:\u002F\u002Flocalhost:3000\u002Furl`.\n\nexamples:\n\n-   http:\u002F\u002Flocalhost:3000\u002Furl\u002Fgitbook.com\u002Fdocs\n-   http:\u002F\u002Flocalhost:3000\u002Furl\u002Fopen-source.gitbook.io\u002Fmidjourney\n\nAny published GitBook site can be accessed through your local development instance, and any updates you make to the codebase will be reflected in your browser.\n\n### CI and testing\n\nAll pull-requests will be tested against both visual and performances testing to prevent regressions.\n\n## Fonts and Icons\n\nGitBook Open uses fontawesome. For self-hosting and local development, for licensing reasons, only the icons from the free version should be used.\n\n## Contributing\n\nGitBook's rendering engine is fully open source and built on top of [Next.js](https:\u002F\u002Fnextjs.org\u002F). Head to our [contributing guide](https:\u002F\u002Fgithub.com\u002FGitbookIO\u002Fgitbook\u002Fblob\u002Fmain\u002F.github\u002FCONTRIBUTING.md) to learn more about the workflow on adding your first Pull Request.\n\n### Types of contributions\n\nWe encourage you to contribute to GitBook to help us build the best tool for documenting technical knowledge. If you're looking for some quick ways to contribute, continue reading to learn more about popular contributions.\n\n#### Translations\n\nThe GitBook UI is rendered using a set of translation files found in [`packages\u002Fgitbook\u002Fsrc\u002Fintl\u002Ftranslations`](\u002Fpackages\u002Fgitbook\u002Fsrc\u002Fintl\u002Ftranslations\u002F). We welcome all additional translations for the UI.\n\n#### Bugs\n\nEncounter a bug or find an issue you'd like to fix? Helping us fix issues related to GitBook greatly improves the experience for everyone. Head to the issues section of this repository to learn more about the types of bugs you can already help out with.\n\n## Deployment\n\n> [!WARNING]  \n> While it is possible to self-host this project, we do not recommend this unless you are certain this option fits your need.\n>\n> _Looking to add a specific feature in GitBook? Head to our [contributing guide](https:\u002F\u002Fgithub.com\u002FGitbookIO\u002Fgitbook\u002Fblob\u002Fmain\u002F.github\u002FCONTRIBUTING.md) to get started._\n>\n> Self-hosting this project puts the responsibility of maintaining and merging future updates on **you**. We cannot guarantee support, maintenance, or updates to forked and self-hosted instances of this project.\n>\n> We want to make it as easy as possible for our community to collaborate and push the future of GitBook, which is why we encourage you to contribute to our product directly instead of creating your own version.\n\nThis project allows you to self-host the rendering portion of your GitBook published content. Self-hosting has pros and cons.\n\nOn the pro side, you can customize the look and feel of your content, and better embed your documentation in your application.\n\nOn the con side, you become responsible for the reliability of your published site, and keeping the renderer up-to-date with the changes made to the GitBook platform.\n\n## License\n\nDistributed under the [GNU GPLv3 License](https:\u002F\u002Fgithub.com\u002FGitBookIO\u002Fgitbook\u002Fblob\u002Fmain\u002FLICENSE).\n\nIf you plan to distribute the code, you must make the source code public to comply with the GNU GPLv3. To clone in a private repository, acquire a [commercial license](https:\u002F\u002Fwww.gitbook.com\u002Fpricing).\n\nSee `LICENSE` for more information.\n\n## Badges\n\n\u003Cp align=\"left\">\n  \u003Ca href=\"https:\u002F\u002Fgitbook.com\">\u003Cimg src=\"https:\u002F\u002Fimg.shields.io\u002Fstatic\u002Fv1?message=Documented%20on%20GitBook&logo=gitbook&logoColor=ffffff&label=%20&labelColor=5c5c5c&color=3F89A1\">\u003C\u002Fa>\n  \u003Ca href=\"https:\u002F\u002Fgitbook.com\">\u003Cimg src=\"https:\u002F\u002Fimg.shields.io\u002Fstatic\u002Fv1?message=Documented%20on%20GitBook&logo=gitbook&logoColor=ffffff&label=%20&labelColor=5c5c5c&color=F4E28D\">\u003C\u002Fa>\n  \u003Ca href=\"https:\u002F\u002Fgitbook.com\">\u003Cimg src=\"https:\u002F\u002Fimg.shields.io\u002Fstatic\u002Fv1?message=Documented%20on%20GitBook&logo=gitbook&logoColor=ffffff&label=%20&labelColor=5c5c5c&color=FDA599\">\u003C\u002Fa>\n\u003C\u002Fp>\n\n```md\n[![GitBook](https:\u002F\u002Fimg.shields.io\u002Fstatic\u002Fv1?message=Documented%20on%20GitBook&logo=gitbook&logoColor=ffffff&label=%20&labelColor=5c5c5c&color=3F89A1)](https:\u002F\u002Fwww.gitbook.com\u002Fpreview?utm_source=gitbook_readme_badge&utm_medium=organic&utm_campaign=preview_documentation&utm_content=link)\n```\n\n```html\n\u003Ca href=\"https:\u002F\u002Fwww.gitbook.com\u002Fpreview?utm_source=gitbook_readme_badge&utm_medium=organic&utm_campaign=preview_documentation&utm_content=link\">\n    \u003Cimg\n        src=\"https:\u002F\u002Fimg.shields.io\u002Fstatic\u002Fv1?message=Documented%20on%20GitBook&logo=gitbook&logoColor=ffffff&label=%20&labelColor=5c5c5c&color=3F89A1\"\n    \u002F>\n\u003C\u002Fa>\n```\n\n## Acknowledgements\n\nGitBook wouldn't be possible without these projects:\n\n-   [Next.js](https:\u002F\u002Fnextjs.org\u002F)\n-   [Bun](https:\u002F\u002Fbun.sh\u002F)\n-   [Tailwind CSS](https:\u002F\u002Ftailwindcss.com\u002F)\n-   [Framer Motion](https:\u002F\u002Fwww.npmjs.com\u002Fpackage\u002Fframer-motion)\n\n## Contributors\n\n\u003Ca href=\"https:\u002F\u002Fgithub.com\u002FgitbookIO\u002Fgitbook\u002Fgraphs\u002Fcontributors\">\n  \u003Cimg src=\"https:\u002F\u002Fcontrib.rocks\u002Fimage?repo=gitbookIO\u002Fgitbook\" \u002F>\n\u003C\u002Fa>\n\n## Legacy GitBook (Deprecated)\n\nOur previous version of GitBook and it's CLI tool are now deprecated. You can still view the old repository and it's commits on this [branch](https:\u002F\u002Fgithub.com\u002FGitbookIO\u002Fgitbook\u002Ftree\u002Flegacy).\n","GitBook 是一个用于管理和发布技术文档的开源平台。它使用 TypeScript 构建，支持 Markdown 格式的文档编写，并通过 Git 进行版本控制，使得团队可以高效协作和维护文档。其核心功能包括文档的创建、编辑、预览以及发布，同时还提供了丰富的插件系统以增强功能。适用于需要集中管理知识库或文档的场景，如软件开发团队的技术文档、产品手册等。项目遵循 GNU General Public License v3.0 开源许可协议，鼓励社区贡献与反馈。",2,"2026-06-11 02:54:52","top_language"]