GitbookIO/gitbook là dự án hướng lập trình viên trên GitHub với 29.1k sao, viết chủ yếu bằng TypeScript. The open source frontend for GitBook doc sites
Tóm tắt dựng từ metadata GitHub của chính dự án — chưa có bài review TopGit. Trang sẽ tự động cập nhật khi bài review đầy đủ được xuất bản.
VÌ SAO CHƯA CÓ REVIEW
TopGit viết bài đầy đủ cho repo có nhiều sao nhất và được yêu cầu nhiều nhất. Trang này là snapshot trong thời gian chờ — xem README gốc ở tab READ ME.
Welcome to GitBook, the platform for managing technical knowledge for teams.
This repository contains the open source code used to render GitBook's published content.
Table of Contents
Getting Started
Contributing
Types of contributions
Licensing
Acknowledgements
Legacy GitBook
Getting Started
To run a local version of this project, please follow these simple steps.
Prerequisites
Node.js (Version: >= 22.3)
Use nvm for easy Node management
Bun (Version: >=1.2.15)
We use a text-based lockfile which isn't supported below 1.2.15
Set up
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.
Any 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.
CI and testing
All pull-requests will be tested against both visual and performances testing to prevent regressions.
Fonts and Icons
GitBook Open uses fontawesome. For self-hosting and local development, for licensing reasons, only the icons from the free version should be used.
Contributing
GitBook's rendering engine is fully open source and built on top of Next.js. Head to our contributing guide to learn how to report bugs and suggest changes.
Types of contributions
We 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.
Translations
The GitBook UI is rendered using a set of translation files found in packages/gitbook/src/intl/translations. Spotted a wrong or missing translation? Open an issue and let us know.
Bugs
Encounter a bug? Open an issue with as much detail as you can. Clear reports help us fix things faster for everyone.
Deployment
[!WARNING]
While it is possible to self-host this project, we do not recommend this unless you are certain this option fits your need.
Looking for a specific feature in GitBook? Head to our contributing guide to suggest it.
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.
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 share your ideas with us instead of creating your own version.
This project allows you to self-host the rendering portion of your GitBook published content. Self-hosting has pros and cons.
On the pro side, you can customize the look and feel of your content, and better embed your documentation in your application.
On 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.
License
Distributed under the GNU GPLv3 License.
If 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.
See LICENSE for more information.
The @gitbook/embed package is an exception: it is distributed under the Apache License 2.0, so it can be used in proprietary applications.
GitbookIO/gitbook thuộc nhóm Developer Tools trên TopGit, cùng 4 topic GitHub. Trang Trending và Topics liệt kê các repo cùng số sao và cùng ngôn ngữ để so sánh.
Đọc thêm về GitbookIO/gitbook ở đâu?
Trang TopGit này là một snapshot — tab "Readme" hiển thị nguyên văn README của repo (đã bỏ link, giữ ảnh). Repo GitHub ở github.com/GitbookIO/gitbook là nguồn chính thức.
GitbookIO/gitbook có bao nhiêu sao?
GitbookIO/gitbook có 29.1k sao GitHub — tải lại trang để xem số mới nhất, hoặc xem trực tiếp github.com/GitbookIO/gitbook. TopGit phản chiếu số sao của GitHub nhưng không cam kết đến từng phút.
GitbookIO/gitbook có những chủ đề gì?
GitHub topics của GitbookIO/gitbook: "documentation", "git", "gitbook", "markdown". TopGit xếp repo vào nhóm Developer Tools.
GitbookIO/gitbook có phải mã nguồn mở không?
Có — GitbookIO/gitbook phát hành theo license GPL-3.0, nghĩa là mã nguồn mở để đọc, fork và (tùy license) tái sử dụng. Mã: github.com/GitbookIO/gitbook.
GitbookIO/gitbook có trang demo không?
Dự án có trang chủ ở https://www.gitbook.com. Tab "Readme" ở trang này thường có ảnh chụp và hướng dẫn bắt đầu nhanh.
GitbookIO/gitbook còn đang phát triển không?
Commit gần nhất trên GitbookIO/gitbook là 3 tháng trước (theo timestamp GitHub). Repo có 4.0k fork — một chỉ báo về mức độ quan tâm của cộng đồng.
Đọc đầy đủ README ở tab phía trên.
Muốn nghe thêm một ý kiến về gitbook?
Hỏi một AI đọc được trang này — một cú bấm là có ngay nhận định về gitbook.