You may want to customise BookStack to use custom branding, or you may just not like the default blue theme. Customising the branding of BookStack is super simple and can be done within the “Settings > Customization” area of the interface. Here you can change the application name, logo and the core colours used. Additional ways to customise are listed below:
To change fonts you can make use of the “Custom HTML Head Content” customization setting by adding custom CSS to alter fonts used. Copy the code below into this setting and alter the font names to your desired fonts:
Here’s an example of using the ‘Lato’ font from Google Web Fonts as the main body text font:
Some additional notes to consider when setting custom fonts:
- Changes won’t apply to the main
/settingspages of BookStack, since custom HTML head content is not applied here.
- If a heading font is not set via
--font-heading, then the
--font-bodyvalue will be used as a fallback.
- This system simply makes use of normal CSS variables, and the values are used for the standard CSS font-family property.
- These fonts won’t apply to PDF exports, where font availability and usage is more limited.
- The font used for
--font-code, if set, should be a monospace font.
Changing Code Block Themes
When inserting code into a page, or when using the Markdown editor, the text you enter is highlighted by the CodeMirror library.
For those that’d prefer a different colour scheme for code blocks, we do provide a custom
which provides a couple of methods that allow registration of CodeMirror UI and syntax highlighting themes.
Default Light/Dark Mode
By default, BookStack will be presented in “light mode”. Users can toggle their light/dark mode preference using one of the buttons either found on the homepage view, or within the header bar user dropdown menu.
If you’d instead like your instance to be presented in “dark mode” by default, you can add the following option to your
Default Book View
By default the
/books page displays your books as a list. Users can change this option to list or grid view but if you’d like to set the default for public viewers or new users you can add the following to your
View the Hacking BookStack page for more advanced ways to achieve deeper customisation.