gsadmin/gitbook
1
0
Fork 0
mirror of https://github.com/GitbookIO/gitbook.git synced 2026-10-04 04:21:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve readme

Browse Source
This commit is contained in:
Samy Pessé
2023-11-23 11:31:04 +01:00
parent 84fd934fe1
commit 2a03461a21
2 changed files with 17 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.env.example
+3 -3
View File
@@ -1,12 +1,12 @@
# Mode to serve only a single space
# Ex: http://localhost:4000
# GITBOOK_MODE=single
GITBOOK_SPACE_ID=your_space_id
GITBOOK_TOKEN=your_token_here
# GITBOOK_SPACE_ID=your_space_id
# GITBOOK_TOKEN=your_token_here
# Mode to serve multiple spaces using the entire url
# Ex: http://docs.mycompany.com/page1
GITBOOK_MODE=multi
# GITBOOK_MODE=multi
# Mode to serve multiple spaces with the space url passed as a path
# Ex: http://localhost:4000/docs.mycompany.com/page1
README.md
+14 -20
View File
@@ -2,19 +2,9 @@
Next.js application to render GitBook published content.
## Self-hosting
This repository is designed to allow self-hosting the rendering of your GitBook published content. Self-hosting has pros and cons, on the pro side you can customize the look and feel and better embed your documentation in your application; on the cons side you become responsible for the reliability and keeping the renderer up-to-date with the changes on the GitBook platform.
This application can easily be configured and deployed on Vercel or Cloudflare to serve a specific space content (**self-hosting**). It requires a minimum amount of configuration:
- `GITBOOK_MODE=single`
- `GITBOOK_SPACE_ID`: ID of the GitBook.com space to render
- `GITBOOK_TOKEN`: a GitBook.com API token that has access to the space defined in `GITBOOK_SPACE_ID`
## Development
#### Installation
#### Start the local server
Clone the repository and use [Bun](https://bun.sh/) to install dependencies and run the local development server.
@@ -22,19 +12,13 @@ Clone the repository and use [Bun](https://bun.sh/) to install dependencies and
bun install
```
#### Local Configuration
To develop and test a GitBook space locally (`http://localhost:3000/<spaceId>/**`), first create a [GitBook API token](https://app.gitbook.com/account/developer) and put it in a `.env.local` file:
To test multiple GitBook content locally, create a `.env.local` file, with the following content:
```
GITBOOK_TOKEN=gb_api_abc
GITBOOK_MODE=multi-path
```
This step is not required when developing using URL lookup (`http://<host>.localhost:3000/<path>`).
#### Start the local server
Run the Next.js development server.
Run the Next.js development server:
```
bun dev
@@ -46,3 +30,13 @@ Then open the space in your web browser, using `http://localhost:3000/<url>` (ex
- `bun format`: format the code
- `bun lint`: lint the code
## Self-hosting
This repository is designed to allow self-hosting the rendering of your GitBook published content. Self-hosting has pros and cons, on the pro side you can customize the look and feel and better embed your documentation in your application; on the cons side you become responsible for the reliability and keeping the renderer up-to-date with the changes on the GitBook platform.
This application can easily be configured and deployed on Vercel or Cloudflare to serve a specific space content (**self-hosting**). It requires a minimum amount of configuration:
- `GITBOOK_MODE=single`
- `GITBOOK_SPACE_ID`: ID of the GitBook.com space to render
- `GITBOOK_TOKEN`: a GitBook.com API token that has access to the space defined in `GITBOOK_SPACE_ID`