Documentation (API and customisation) — BookStack

Cited by

Facts read from this source

• Rest API Report an error

  “BookStack has a built-in REST API for external interaction and consumption of your BookStack data.”

• API docs path Report an error

  “API documentation can be found within your BookStack instance at the /api/docs URL path.”

• API permission required Report an error

  “You’ll need to have the ‘Access system API’ role permission to access the API.”

• Custom html head option Report an error

  “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.”

• Visual theme system Report an error

  “BookStack allows visual customization via the theme system which enables you to extensively customize views, translation text & icons.”

• Logical theme system Report an error

  “BookStack allows PHP code-based extension via what we call the “Logical Theme System”. This works by hooking into specific events where you can then perform custom actions or extension of the underlying framework.”

• Javascript public events Report an error

  “BookStack emits events as part of their lifecycle so that you can define listeners to hook into these events.”

• Tag classes Report an error

  “When viewing an item with tags applied, those tags will be normalized to CSS classes and applied to the <body> element of the page.”

• Tag class normalization Report an error

  “For the normalization to classes, the following is done to both the name and value of the tag: Text is lower-cased Spaces and hyphens are stripped”

• Export classes Report an error

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

• Pdf export engines Report an error

  “export-engine-dompdf - PDF exports using the default DomPDF rendering engine”

• Child item tag inheritance Report an error

  “Chapters and pages will also receive tag classes from their parent book/chapter, prefixed with their item type.”

• Hacks not supported Report an error

  “Customisation options on this page are not deemed to be stable or officially supported. BookStack core files may change on any release causing changes in behaviour to your hacks.”

• Theme overrides not supported Report an error

  “Theme overrides are not officially supported in any way.”

• Logical theme stable API only Report an error

  “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.”

Scores citing this record

• The Engineering Lead Help-center publishing & integrations
• The IT Administrator Help-center publishing & integrations
• The Operations Lead Help-center publishing & integrations
• The Quality Manager Help-center publishing & integrations
• The Skeptic Help-center publishing & integrations
• The Support Knowledge Manager Help-center publishing & integrations