Sebastian Graz
aab7d0bd7a
* first stab at bullet points * setup theming, custom opacities, use of brand UI colors * color key change * delete brand * setup initial defaults * Add opacity parameter to primary color * style TOC * styling pass header, footer, hints, toc, trademark * table pass * style pass, typo, quote, tabs, search, theme, toc
GitBook
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=singleGITBOOK_SPACE_ID: ID of the GitBook.com space to renderGITBOOK_TOKEN: a GitBook.com API token that has access to the space defined inGITBOOK_SPACE_ID
Development
Installation
Clone the repository and use Bun to install dependencies and run the local development server.
bun install
Local Configuration
To develop and test a GitBook space locally (http://localhost:3000/<spaceId>/**), first create a GitBook API token and put it in a .env.local file:
GITBOOK_TOKEN=gb_api_abc
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.
bun dev
Then open the space in your web browser, using http://localhost:3000/<url> (example: http://localhost:3000/docs.gitbook.com).
Other development commands
bun format: format the codebun lint: lint the code