mirror of https://github.com/GitbookIO/gitbook.git synced 2026-09-16 15:45:13 +00:00

T

Samy Pessé 462b2b6e65 Add support for no header in customization settings (#3 )

* Start hiding header

* Adapt page aside as well

* Revert condition

2023-11-13 22:08:29 +01:00

src

Add support for no header in customization settings (#3 )

2023-11-13 22:08:29 +01:00

types

Fix some TS issues and group import during lint (#2 )

2023-11-12 21:17:18 +01:00

.env.example

Start

2023-10-22 23:48:31 +02:00

.eslintrc.json

Fix some TS issues and group import during lint (#2 )

2023-11-12 21:17:18 +01:00

.gitignore

Initial commit from Create Next App

2023-10-22 15:24:44 +02:00

.prettierignore

Start

2023-10-22 23:48:31 +02:00

.prettierrc.json

Start

2023-10-22 23:48:31 +02:00

bun.lockb

Fix some TS issues and group import during lint (#2 )

2023-11-12 21:17:18 +01:00

next.config.js

Disable typechecking in next build

2023-10-29 23:32:55 -04:00

package.json

Fix some TS issues and group import during lint (#2 )

2023-11-12 21:17:18 +01:00

postcss.config.js

Start

2023-10-22 23:48:31 +02:00

README.md

Try more blocks

2023-11-01 13:41:14 -04:00

tailwind.config.ts

Start theming header

2023-11-03 22:58:04 -04:00

tsconfig.json

Start highlighting of code blocks

2023-10-24 13:36:32 +02:00

README.md

GitBook

Next.js application to render GitBook published content.

Development

Installation

Clone the repository and use Bun to install dependencies and run the local development server.

bun install

Configuration

To develop and test a GitBook space locally, first create a GitBook API token and put it in a .env.local file:

GITBOOK_TOKEN=gb_api_abc

Start the local server

Run the Next.js development server.

bun dev

Then open the space in your web browser: http://localhost:3000/<space>/.

Other commands

bun format: format the code
bun lint: lint the code

Differences

Changed: Full-width mode:
- When off, layout is centered
- It now detects based on the page
New: Scroll to top button in page aside
New: Proper RTL support
New: Per page OpenGraph cover image