]> BookStack Code Mirror - website/blobdiff - readme.md
Updated slug handling due to deprecation
[website] / readme.md
index 6332410095e76b9e9b586ad1c8bd30af5905ecc1..1ee17f34798b1180b36ebbdaf4edd0de8957e9dd 100644 (file)
--- a/readme.md
+++ b/readme.md
@@ -1,6 +1,6 @@
 # BookStack Site, Documentation & Blog
 
-This project holds all the data for the https://www.bookstackapp.com/
+This project holds all the data for the https://www.bookstackapp.com/ website.
 
 This site is built using [Hugo](https://gohugo.io). Images are stored using `git-lfs`.
 The "extended" version of hugo must be used (Has support for certain features like WebP resize).
@@ -14,7 +14,8 @@ The "extended" version of hugo must be used (Has support for certain features li
 ### Hacks
 
 The website also contains a repository of customization hacks which can be found at [the /hacks](https://www.bookstackapp.com/hacks/) part of the site. 
-These are managed via a [separate "Hacks" repo](https://codeberg.org/bookstack/hacks) which is part of this repository as a git submodule. A symlink is then used to point the `content/hacks` directory to the `hacks/content` directory, where `hacks` is the submodule location.
+These are managed via a [separate "Hacks" repo](https://codeberg.org/bookstack/hacks) which is part of this repository as a git submodule.
+This is included into this site repo as [a module mount](https://gohugo.io/configuration/module/#mounts).
 
 ### Theme
 
@@ -44,4 +45,4 @@ location ~* \.(db)$ {
 }
 ```
 
-Much of the search UI handling logic can be found in our `themes/bookstack/static/js/scripts.js` file.
\ No newline at end of file
+Much of the search UI handling logic can be found in our `themes/bookstack/static/js/scripts.js` file.