GitbookIO/gitbook

Getting Started

To run a local version of this project, please follow these simple steps.

Deployment

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.

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

Table of Contents

• Getting Started
• Contributing
• Types of contributions
• Acknowledgements
• Legacy GitBook

Set up

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.

• 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
• Ensure you are using the project's version of node. Running nvm use will change your local version to the correct one.
• Install the project's dependencies through Bun.
• Start your local development server.
• Open a published GitBook space in your web browser, prefixing it with http://localhost:3000/url.
• http://localhost:3000/url/gitbook.com/docs
• http://localhost:3000/url/open-source.gitbook.io/midjourney

概述

Docs - Community - Developer Docs - Changelog - Bug reports - Feature requests

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.