bookstack/website
6
12
Fork 5
Code Issues 5 Pull requests Activity

Added links to hack pages

Browse source
This commit is contained in:
Dan Brown 2023-02-12 19:07:20 +00:00
commit 8c64e09cbb
Signed by: danb
GPG key ID: 46D9F943C24A2EF9
4 changed files with 19 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

10
content/docs/admin/hacking-bookstack.md
View file

@ -13,6 +13,12 @@ _**Note: Customisation options on this page are not deemed to be stable or offic
---
### BookStack Hacks Directory
This website has a directory of available hacks [which can be found here](/hacks/).
These make use of the [Custom HTML Head Option](#custom-html-head-option), [Visual Theme System](#visual-theme-system) and [Logical Theme System](#logical-theme-system) options listed below.
---
### BookStack API
@ -29,6 +35,7 @@ BookStack has a built-in REST API for external interaction and consumption of yo
Within the settings area you'll find a 'Custom HTML head content' setting. You can use this to add in any custom JavaScript or CSS content which enables you to override default BookStack functionality and styles.
You can find examples of custom HTML Head customizations on the [hacks part of this site](/hacks/).
---
@ -39,6 +46,7 @@ Documentation for this system is contained within [the project repo here](https:
_**Note: The files that can be override using the theme system are not deemed to be stable. BookStack core files may change on any release causing changes in behaviour to your overrides. Theme overrides are not officially supported in any way.**_
You can find examples visual theme system customizations on the [hacks part of this site](/hacks/).
---
@ -50,6 +58,8 @@ Documentation for this system is contained within [the project repo here](https:
_**Note: Only the API described in the logical-theme-system document is considered stable & supported. Any usage of other application classes is regarded as unstable and unsupported.**_
You can find examples of logical theme system customizations on the [hacks part of this site](/hacks/).
---
### BookStack Editor Events

1
themes/bookstack/layouts/partials/footer.html
View file

@ -25,6 +25,7 @@
<li><a href="{{.Site.BaseURL}}#demo">View the Demo</a></li>
<li><a href="{{.Site.BaseURL}}blog" target="_blank">Read our Blog</a></li>
<li><a href="{{.Site.BaseURL}}donate">Donate</a></li>
<li><a href="{{.Site.BaseURL}}hacks">Hacks</a></li>
</ul>
</div>
<div class="col-xs-6 col-sm-4 col-lg-2">

7
themes/bookstack/layouts/partials/header.html
View file

@ -128,6 +128,13 @@
<p>Get the latest project news from our blog</p>
</div>
</a>
<a href="/hacks" class="nav-dropdown-item">
<div class="nav-dropdown-item-icon" aria-hidden="true">{{partial "icon/hacks.svg"}}</div>
<div>
<div class="nav-dropdown-item-title">Hacks</div>
<p>Unsupported hacks that can be applied</p>
</div>
</a>
</div>
</div>
<div class="nav-dropdown-wrap">

1
themes/bookstack/layouts/partials/icon/hacks.svg Normal file
View file

@ -0,0 +1 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19.73,14.23L7.71,2.21c-0.39-0.39-1.02-0.39-1.41,0L3.7,4.8C3.36,5.14,3.31,5.68,3.59,6.08l7.65,10.98 c-0.78,0.78-0.78,2.05,0,2.83l1.41,1.41c0.78,0.78,2.05,0.78,2.83,0l4.24-4.24C20.51,16.28,20.51,15.01,19.73,14.23z M14.07,19.88 l-1.41-1.41l4.24-4.24l1.41,1.41L14.07,19.88z"/></svg>
Side by side

After

Width:  |  Height:  |  Size: 348 B