BookStack Code Mirror - website/blobdiff - content/docs/admin/hacking-bookstack.md

diff --git a/content/docs/admin/hacking-bookstack.md b/content/docs/admin/hacking-bookstack.md

index 0d678727fd55b2cd7353f2907cb63b548761fab2..fe105849cd35d556472d501a256d8ceb8ccda90f 100644 (file)

--- a/content/docs/admin/hacking-bookstack.md

+++ b/content/docs/admin/hacking-bookstack.md

@@ -27,13 +27,13 @@ BookStack has a built-in REST API for external interaction and consumption of yo

**Reference Links**

- [API documentation of our demo instance](https://demo.bookstackapp.com/api/docs).

-- [Our "BookStack API Scripts" repo containing examples](https://github.com/BookStackApp/api-scripts).

+- [Our "BookStack API Scripts" repo containing examples](https://codeberg.org/bookstack/api-scripts).

---

### Custom HTML Head Option

-Within the customization 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.

+Within the "Settings > Customization" view within BookStack 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/).

@@ -62,15 +62,15 @@ You can find examples of logical theme system customizations on the [hacks part

---

-### BookStack JavaScript Public Events

-

+### BookStack JavaScript Public Events

+

To allow customization of the JavaScript libraries & components used, BookStack emits events as part of their lifecycle

-so that you can define listeners to hook into these events. These can often be used by adding custom scripts to the

+so that you can define listeners to hook into these events. These can often be used by adding scripts to the

[custom HTML head content option](#custom-html-head-option).

-You can find details of a listing of all events [within the project repo here](https://github.com/BookStackApp/BookStack/blob/development/dev/docs/javascript-public-events.md).

+You can find details and a listing of all events [within the project repo here](https://github.com/BookStackApp/BookStack/blob/development/dev/docs/javascript-public-events.md).

---

@@ -96,4 +96,27 @@ As an example of usage, pages with the tag `Priority: Critical` could have their

<style>

.tag-pair-priority-critical .page-content { color: red; }

</style>

+```

+

+---

+

+### Export Classes

+

+When PDF or HTML exports are performed in BookStack, the underlying templates define classes to allow customization of styling in specific scenarios.

+For context, PDF exports are rendered via a conversion from HTML to PDF, so CSS styling can be applied for these but support may depend on the underlying PDF conversion engine.

+The classes are applied to the `<body>` element, and are as follows:

+

+- `export` - All HTML/PDF exports

+- `export-format-pdf` - PDF exports

+- `export-format-html` - HTML exports

+- `export-engine-dompdf` - PDF exports using the default DomPDF rendering engine

+- `export-engine-wkhtml` - PDF exports using the default DomPDF rendering engine

+- `export-engine-command` - PDF exports using the command-based PDF rendering option

+

+As an example usage, you could define the following custom style code to make paragraph text red only in PDF exports created via the default DomPDF renderer:

+

+```html

+<style>

+.export-format-pdf.export-engine-dompdf p { color: red; }

+</style>

```

\ No newline at end of file