https://github.com/bookstackapp/hacks
MIGRATED TO CODEBERG -- Collection of hacks we have on the main website
https://github.com/bookstackapp/hacks
Last synced: 8 months ago
JSON representation
MIGRATED TO CODEBERG -- Collection of hacks we have on the main website
- Host: GitHub
- URL: https://github.com/bookstackapp/hacks
- Owner: BookStackApp
- License: mit
- Archived: true
- Created: 2023-02-12T18:40:21.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-07-12T14:02:15.000Z (over 1 year ago)
- Last Synced: 2025-03-05T10:49:02.578Z (10 months ago)
- Language: HTML
- Homepage: https://codeberg.org/bookstack/hacks
- Size: 63.5 KB
- Stars: 7
- Watchers: 3
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# BookStack Hacks
This repository contains the hacks that are shown on the [/hacks part of the website](https://www.bookstackapp.com/hacks/). This is not a website in itself,
but it designed to be a submodule within the `hacks/` directory of the [BookStack website repo](https://github.com/BookStackApp/website).
### 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](https://www.httpfunctions.com/).
### 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.