bookstack/website
Fork 4
Code Issues 5 Pull requests Activity

Added hacks blogpost

Browse source
This commit is contained in:
Dan Brown 2023-02-15 18:19:17 +00:00
commit b2752486ad
Signed by: danb
GPG key ID: 46D9F943C24A2EF9
2 changed files with 46 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

43
content/blog/hacks-on-the-site.md Normal file
View file

@ -0,0 +1,43 @@
+++
categories = ["News"]
tags = ["News"]
title = "Customization Hacks on the BookStack Site"
date = 2023-02-15T17:30:00Z
author = "Dan Brown"
image = "/images/blog-cover-images/stump-yves-alarie.jpg"
slug = "hacks-on-the-site"
draft = false
+++
Over the last few years BookStack has gained a [few different methods](/docs/admin/hacking-bookstack/) that can be used
to customize functionally and aesthetics.
Quite often, for ideas that don't quite fit for quick implementation within the
core BookStack codebase, I'd provide a simplistic customization that can used
to achieve that idea right now, using BookStack's methods of hackery.
These were scattered around GitHub issues, GitHub gists and discord messages, which required me to also provide implementation guidance each time.
To organize and streamline the process of sharing these, there's now a dedicated
section on the BookStack site:
[www.bookstackapp.com/hacks/](https://www.bookstackapp.com/hacks/)
Each hack is shown in a relatively standardized format,
and implementation instructions are centralized & linked to from each file
listed for the hack.
Each hack also shows some details such as the creator and the last version of BookStack it was tested against.
I have to stress, these hacks are unsupported and are not assured to be updated or work
with future BookStack versions. There are usually reasons these are not implemented as core features already, and I cannot afford to widen the scope of the support already provided for the core platform/code.
While part of the site, hacks are managed via [a separate repo here](https://github.com/BookStackApp/hacks). Contributions are welcome but the scope of those is relatively strict to keep maintenance reasonable so please read the readme first.
This new area may evolve over time. I've set this up to potentially work with
code-driven systems in the future, with the idea of being able to easily add
these to BookStack via a single command, or something similar.
I'm also toying with the idea of monetizing these via some kind of hack build/update
service offering.
But for now, I'm just looking to build up this collection over time and gain an
idea of whether this is useful while assessing its project maintenance impact.
----
<span style="font-size: 0.8em;opacity:0.9;">Header Image Credits: <span>Photo by <a href="https://unsplash.com/@yvesalarie?utm_source=unsplash&utm_medium=referral&utm_content=creditCopyText">Yves Alarie</a> on <a href="https://unsplash.com/photos/vBFfFMZOroQ?utm_source=unsplash&utm_medium=referral&utm_content=creditCopyText">Unsplash</a></span></span>