bookstack/hacks
2
0
Fork 2
Code Issues Pull requests Activity
Collection of hacks we have on the main website
53 commits 1 branch 0 tags 296 KiB
Find a file
Dan Brown a7185d10f9
Reviewed mermaid viewer hack 
Modified with the changes:
- Split out files to make use of the public files system, and so it's
  not a massive chunk of head content loaded on all pages.
- Added a little extra size control during load to reduce bouncing.
- Updated code block targeting just to avoid potention editor conflicts.
- Removed some non-existing CSS variable usages.
- Tweaked hack wording/guidance a little.
2025-06-27 14:54:59 +01:00
.github Added funding and readme files 2023-02-12 23:35:18 +00:00
content Reviewed mermaid viewer hack 2025-06-27 14:54:59 +01:00
.gitignore Added .gitignore file 2023-02-14 16:08:21 +00:00
LICENSE Updated license year, and changed repo refereces to Codeberg 2024-07-27 11:53:57 +01:00
readme.md Updated license year, and changed repo refereces to Codeberg 2024-07-27 11:53:57 +01:00

readme.md

BookStack Hacks

This repository contains the hacks that are shown on the /hacks part of the website. This is not a website in itself, but it designed to be a submodule within the hacks/ directory of the BookStack website repo.

Hack Update Service

As a way to sustainably maintain hacks, a hack update service is advertised on hack pages which allows people to pay a one-off fee to request an update of a hack to work with the latest release of BookStack. This service is provided by HTTP Functions Ltd.

Support & Issues

Hacks in this repo are unsupported, maybe become out-of-date and do not receive active maintenance unlike the core BookStack codebase.

Feel free to raise an issue for bugs or incorrect content but please do not open issues for:

  • Requesting new hacks, or variations of existing hacks.
  • Guidance/support for implementing, using or maintaining hacks.
  • Issues when using hacks on BookStack versions they're not lasted tested for.
  • Providing details to update a hack (Open a PR instead).
  • Limitations in existing hacks.

Contributions & Scope

Contributions are welcome to this repository but the scope for additions will be relatively strict to keep maintenance dept minimal. Please don't assume any customizations/hacks will be accepted here. The scope will be as follows:

  • There should be minimal overlap with an existing hack.
  • The hack should have a relatively minimal surface area.
  • The hack should have a reasonably low chance of conflicting with future updates.
  • The hack should have a low likelihood of inadvertently causing additional problems.
  • Hacks should not have external platform-specific requirements.

Pull requests to update hacks for more recent compatibility are welcome, as long as they don't apply additional non-required changes.

Contributions will become under the MIT license of the project.