Sebastian Graz
caa74cf48f
* fix tab multiline * OpenAPI improvements (#127) * Fix display of authentication infos * Fix property names * Fix body / request starting with oneOf * CSS fixes * Show description * Format * Fix code samples * Convert swagger 2.0 to OpenAPI v3 (#128) * Convert swagger 2.0 to OpenAPI 3 * Format * Fix page with one api block shown as empty (#129) * Fix page with one api block shown as empty * Format * Style sprint (#126) * V1 code blocks fix * equalize modal text label + fix safari bug with fixed position stroke * code block adjustments * fix search result spacing * remove metal + adjust light and dark mode * remove metal from tw config * Add colordebugger + remove unused global colors * correct opacities on all colors * first part of cleaning up colors * fix tab colors * search modal color changes * adjust global colors * expandable + code color changes * add delay to loading panes * adjust globals * improve select table type * improve light mode checkbox * fix delay * content * uncomment debug * expandable fixes * OpenAPI improvements (#127) * Fix display of authentication infos * Fix property names * Fix body / request starting with oneOf * CSS fixes * Show description * Format * Fix code samples * Fix empty API responses not being displayed (#130) * Fix response not being displayed when contains no body * Fix padding * Resolve any JSON/YAML OpenAPI file and resolve common parameters (#132) * Fix parsing of OpenAPI when content-type is unknown * Resolve common parameters * Format * Add support for straight corners (#131) * Add class to body and tailwind variant * Use it on the search button * Use it for buttons and cookies banner * Use it for cards * Use it in more places * Lint * More * page feedback * theme toggler * Rename Authentication to Authorization (#133) * remove unused color light-5 * fix dupe css --------- Co-authored-by: Samy Pessé <samypesse@gmail.com>
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
Run the Next.js development server:
bun dev
Then open the space in your web browser, using http://localhost:3000/<host>/<path> (example: http://localhost:3000/docs.gitbook.com).
Other development commands
bun format: format the codebun lint: lint the code
CI and testing
All pull-requests will be tested against both visual and performances testing to prevent regressions.
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