Sebastian Graz
86fe37f968
* add search spinner * better dark/light settings * text color use textarea for input to get multiline * fix fonts * fix margins on result * fix local ascent override, primary spinner color * fix overflow * fix overflow not scrolling all the way up * testing hiding sidescroller on hover * add better hover * no-answer fix
GitBook
Next.js application to render GitBook published content.
Development
Start the local server
Clone the repository and use Bun to install dependencies and run the local development server.
bun install
To test multiple GitBook content locally, create a .env.local file, with the following content:
GITBOOK_MODE=multi-path
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
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