They can cause instability, introduce issues and may conflict with future updates. Apply at your own risk!
IFrame Specific Tweaks
This hack will add custom styles & scripts, hiding many parts of the interface while adding additional light/dark mode control, intended to provide a cleaner view that’s suitable for use within iframes embedded on external pages.
This can be useful if you use BookStack as a knowledge base, and you want to integrate contextual help for your app, with content from BookStack.
Considerations
- The forced dark/light mode control works via JavaScript, so will not run where a user has JavaScript disabled although this is relatively rare.
- This specific example will only affect the loaded page view, not subsequent clicks to other parts of the application within the iframe.
Usage
Use the original page url, with the GET query params iframe=true
and theme=dark|light
. For example:
|
|
The styles and script logic provided is just an example starting point. You should customize these to suit your own needs.
Code
layouts/parts/base-body-start.blade.php
|
|
Request an Update
Hack not working on the latest version of BookStack?
You can request this hack to be updated & tested for a small one-time fee.
This helps keeps these hacks updated & maintained in a sustainable manner.
Latest Hacks
Tag Values in Page Content via Includes
This hack allows you to dynamically pull in the value of tags into page content, via customizing how page include tags are parsed. This hack will attempt to use tags on the page itself, then look to the parent chapter (if existing), then the parent book’s tags. »
Mermaid Viewer
This hack enables interactive Mermaid diagrams to be rendered within a page on BookStack. The Mermaid diagram code itself can be written & edited using either BookStack’s WYSIWYG editor, by creating a code block and assigning it the language “mermaid”, or via the Markdown editor using standard mermaid code fences like so: »
Interactive Embedded Page Drawings
This hack will, on page view, attempt to convert any drawing images into interactive embedded drawing viewers so that you’ll be able to pan & zoom around the drawings while also being able to interact with things like links within the drawings. »
Dynamic Glossary
This hack adds the ability to write global and book-level glossaries, which will then be utilised when viewing pages by marking those words in page content with a dashed underline. On hover, the set definitions will show in a popup below the word. »