Skip to main content

Customization

The plugin ships with default styles that match GitBook's look and feel. You can override any of these using CSS variables in your custom.css file.

Overriding CSS variables

Add overrides to your Docusaurus src/css/custom.css:

:root {
/* Change the primary accent color */
--gitbook-primary: #5b21b6;
--gitbook-primary-hover: #4c1d95;
}

Available variables

Primary colors

VariableDefault (light)Default (dark)Description
--gitbook-primary#0969da#58a6ffPrimary accent color
--gitbook-primary-hover#0756b3#79b8ffPrimary hover color

Tabs

VariableDefault (light)Default (dark)Description
--gitbook-tabs-border#e0e0e0#444Tab bar border color
--gitbook-tab-color#666#aaaInactive tab text
--gitbook-tab-hover-color#333#dddTab hover text
--gitbook-tab-active-color#0969da#58a6ffActive tab text
--gitbook-tab-active-border#0969da#58a6ffActive tab border

Stepper

VariableDefault (light)Default (dark)Description
--gitbook-step-bg#0969da#58a6ffStep number background
--gitbook-step-color#fff#fffStep number text
--gitbook-step-line#e0e0e0#444Vertical connector line

Updates / Timeline

VariableDefault (light)Default (dark)Description
--gitbook-update-dot#0969da#58a6ffTimeline dot color
--gitbook-update-line#e0e0e0#444Timeline line color
--gitbook-update-date-color#666#aaaDate text color

Buttons

VariableDefault (light)Default (dark)Description
--gitbook-button-primary-bg#0969da#58a6ffPrimary button background
--gitbook-button-primary-color#fff#000Primary button text
--gitbook-button-primary-hover-bg#0756b3#79b8ffPrimary button hover
--gitbook-button-secondary-color#0969da#58a6ffSecondary button text
--gitbook-button-secondary-border#0969da#58a6ffSecondary button border
--gitbook-button-secondary-hover-bgrgba(9,105,218,0.1)rgba(88,166,255,0.1)Secondary button hover

Cards

VariableDefault (light)Default (dark)Description
--gitbook-card-border#e0e0e0#444Card border color
--gitbook-card-bg#fff#2a2a2aCard background
--gitbook-card-hover-border#0969da#58a6ffCard hover border
--gitbook-card-title-color#0969da#58a6ffCard title color
--gitbook-card-content-color#666#aaaCard content text

File blocks

VariableDefault (light)Default (dark)Description
--gitbook-file-border#e0e0e0#444File block border
--gitbook-file-bg#f9f9f9#2a2a2aFile block background
--gitbook-file-link-color#0969da#58a6ffFile link color
--gitbook-file-desc-color#666#aaaFile description text

Embeds

VariableDefault (light)Default (dark)Description
--gitbook-embed-bg#f5f5f5#2a2a2aEmbed background
--gitbook-embed-link-color#0969da#58a6ffEmbed link color

Code blocks

VariableDefault (light)Default (dark)Description
--gitbook-code-border#e0e0e0#444Code block border
--gitbook-code-header-bg#f6f8fa#2a2a2aCode title bar background
--gitbook-code-title-color#666#aaaCode title text

Dark mode

Dark mode overrides are applied automatically via the [data-theme='dark'] selector. If you need to override dark mode separately:

[data-theme='dark'] {
--gitbook-primary: #a78bfa;
--gitbook-primary-hover: #c4b5fd;
}

Swizzling components

For deeper customization, you can swizzle any of the theme components:

npx docusaurus swizzle docusaurus-plugin-gitbook GitBookTabs

Available components: GitBookCover, GitBookTabs, GitBookTab, GitBookStepper, GitBookStep, GitBookColumns, GitBookColumn, GitBookUpdates, GitBookUpdate, GitBookCodeBlock, GitBookEmbed, GitBookFile, GitBookButton, GitBookCards, GitBookCard, FAIcon.