Watch
1
0
Fork
You've already forked weraldiz-bookstack-theme
0
Dark-fantasy theme for BookStack
  • JavaScript 55.5%
  • CSS 35.8%
  • Blade 4.9%
  • PHP 3%
  • Shell 0.8%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
2026-10-17 18:00:28 +02:00
bin Initial release 0.1.0 2026-10-04 13:22:32 +02:00
layouts/parts Initial release 0.1.0 2026-10-04 13:22:32 +02:00
public Fix stuck ripple filter, theme notifications, scope declutter rules 2026-10-04 15:10:43 +02:00
screenshots Initial release 0.1.0 2026-10-04 13:22:32 +02:00
.gitignore Initial release 0.1.0 2026-10-04 13:22:32 +02:00
functions.php Fix stuck ripple filter, theme notifications, scope declutter rules 2026-10-04 15:10:43 +02:00
LICENSE Initial release 0.1.0 2026-10-04 13:22:32 +02:00
README.md Shorter README 2026-10-17 18:00:28 +02:00

Weraldiz BookStack Theme

A theme for BookStack: a murex purple, pitch and vellum palette, Cinzel headings over Libre Baskerville text, framed images, and content that fades in as you scroll. It began as the theme of the Weraldiz worldbuilding wiki; this is that theme without the site's landing page and other site-specific parts.

Light Dark
Books overview, light mode Books overview, dark mode
A page, light mode A page, dark mode

BookStack v26.09.1 with the recommended colour settings below. Demo content and covers made for the screenshots.

Features

  • A light (vellum) and a dark (pitch) mode from one set of colour tokens.
  • Self-hosted fonts, so the wiki makes no requests to Google.
  • Content fades in as it scrolls into view, headings reveal letter by letter, and scrolling is smooth.
  • Framed images that open larger on click.
  • Themed forms, editors and notifications in both modes.
  • Optional click effects (sparks and a page ripple) and an optional "declutter" mode for public, read-mostly wikis.
  • Respects reduced motion, works without JavaScript, and never leaves the page blank if a script fails.

Requirements

  • BookStack v26.09 or later (built against v26.09.1)
  • Access to BookStack's files, to add a folder to themes/ and edit .env

Installation

  1. Copy this repository to themes/weraldiz/ inside your BookStack installation (with the linuxserver.io Docker image: /config/www/themes/weraldiz/).
  2. In BookStack's .env, set APP_THEME=weraldiz.
  3. Reload BookStack.
  4. Optionally, set BookStack's own colours to match (Settings › Customization › Application Color Scheme), or links and icons stay BookStack blue:
    Setting Light Dark
    Primary Color #ecdce5 #120a11
    Default Link Color #1d131c #fefcfd
    Shelf Color #4b2f48 #e3d4e0
    Book Color #5f3a5c #c4adc2
    Chapter Color #83607f #a2869f
    Page Color #a2869f #83607f
    Page Draft Color #e3d4e0 #5a4d59

To update, replace the folder's contents. In a container, make sure the files belong to the user the container runs as. bin/build.sh writes an optional minified copy to dist/ (needs Node.js).

Options

Two switches at the top of functions.php:

Option Default What it does
effects true Sparks and a page ripple on clicks on empty page areas (off for reduced motion, in Firefox, and the ripple on touch devices).
declutter false Hides parts of BookStack's interface such as Recent Activity, Revisions and the page Details block, and more for guests. Edit public/css/declutter.css to keep anything.

For page authors

Classes you can put on elements in a page's HTML:

Class Effect
image-float-left, image-float-right, image-float-left-small, image-full-width Floated or full-width image with a gradient frame
no-frame, transparent-bg, no-zoom Image without a frame, for transparent images, or without click-to-zoom
fade-in, fade-in-left, fade-in-right (-delay), image-fade-in, container-slide-left, text-fade-up Scroll-in animations
weraldiz-button Call-to-action link button (add <span class="button-glow"></span> for a glow)
inlink Teal inline link

Customization

Colours live in public/css/core.css (brand hues at the top of :root, dark mode in the html.dark-mode block), animation timings in public/js/wz-reveal.js, spark settings in public/js/wz-sparks.js.

Known limits

  • The theme overrides four of BookStack's views, which BookStack doesn't treat as a stable interface, so check it after each BookStack update.
  • The legacy TinyMCE editor and the markdown editor's preview pane are not themed.
  • If you set STYLE_SOURCES yourself, keep unsafe-inline in it for the no-JavaScript fallback.

AI disclosure

This theme was created by AI with the help of human ideas.

License

The theme is MIT licensed. Bundled third-party files keep their own licences:

Not affiliated with BookStack.