gitbook

<p align="center">
  <img src="./assets/gitbook_icon_dark.svg" alt="GitBook" width="48" />
</p>

<h1 align="center">GitBook</h1>

<p align="center">
  <a href="https://gitbook.com/docs/">Docs</a> - <a href="https://github.com/GitbookIO/community">Community</a> - <a href="https://developer.gitbook.com/">Developer Docs</a> - <a href="https://changelog.gitbook.com/">Changelog</a> - <a href="https://github.com/GitbookIO/gitbook/issues/new?assignees=&labels=bug&template=bug_report.md">Bug reports</a> - <a href="https://github.com/orgs/GitbookIO/discussions/categories/feature-requests">Feature requests</a> 
</p>

<p align="center">
  <a href="https://gitbook.com"><img src="https://img.shields.io/static/v1?message=Documented%20on%20GitBook&logo=gitbook&logoColor=ffffff&label=%20&labelColor=5c5c5c&color=3F89A1"></a>
  <a href="#"><img src="https://img.shields.io/badge/Open_Source-❤️-FDA599?"/></a>
  <a href="/LICENSE"><img src="https://img.shields.io/badge/License-GNU_GPLv3-F4E28D"/></a>
  <a href="/.github/CONTRIBUTING.md"><img src="https://img.shields.io/github/contributors/gitbookIO/gitbook"/></a>
  <a href="https://github.com/gitbookIO/gitbook/issues"><img src="https://img.shields.io/github/issues/gitbookIO/gitbook"/></a>
</p>

<p align="center">Welcome to GitBook, the platform for managing technical knowledge for teams.</p>

<p align="center">This repository contains the open source code used to render GitBook's published content.</p>

<p align="center">
  <img alt="GitBook Open Published Site" src="./assets/published-site.png">
</p>

## Table of Contents

-   [Getting Started](#getting-started)
-   [Contributing](#contributing)
    -   [Types of contributions](#types-of-contributions)
-   [Licensing](#license)
-   [Acknowledgements](#acknowledgements)
-   [Legacy GitBook](#legacy-gitbook-deprecated)

## 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](https://bun.sh/) (Version: >=1.2.15)
  - We use a text-based lockfile which isn't supported below 1.2.15

### Set up

1. 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://www.gitbook.com/pricing).

```
git clone https://github.com/gitbookIO/gitbook.git
```

2. Ensure you are using the project's version of `node`. Running `nvm use` will change your local version to the correct one.

3. Install the project's dependencies through Bun.

```
bun install
```

4. Start your local development server.

```
bun dev
```

6. Open a published GitBook space in your web browser, prefixing it with `http://localhost:3000/url`.

examples:

-   http://localhost:3000/url/gitbook.com/docs
-   http://localhost:3000/url/open-source.gitbook.io/midjourney

Any published GitBook site can be accessed through your local development