Developer guides #1381

New Issue

OVERLORD · 2026-02-05T00:44:36+03:00

OVERLORD commented

2026-02-05 00:44:36 +03:00

Originally created by @NaLiJa on GitHub (Sep 26, 2019).

It would be great to have some guides or tutorials for developers on extending Bookstack, say some overview about the app structure and some hints about properly implementing new features.

For example I am considering adding a plugin to bookstack and I could probably add it „somehow“, but what would be the preferred way of

adding a new icon to the page editor
opening an editor window like the code editor
handling database changes
storing and identifying the data (binary or json data)
loading the dats on page
...

Thanks for reading

Originally created by @NaLiJa on GitHub (Sep 26, 2019). It would be great to have some guides or tutorials for developers on extending Bookstack, say some overview about the app structure and some hints about properly implementing new features. For example I am considering adding a plugin to bookstack and I could probably add it „somehow“, but what would be the preferred way of * adding a new icon to the page editor * opening an editor window like the code editor * handling database changes * storing and identifying the data (binary or json data) * loading the dats on page * ... Thanks for reading

OVERLORD closed this issue

2026-02-05 00:44:39 +03:00

OVERLORD commented

2026-02-05 00:44:43 +03:00

@ssddanbrown commented on GitHub (Sep 27, 2019):

Hi @NaLiJa,
We currently do not provide, or really support, a way to implement plug-ins in this manner at all.
We're looking to increase the extensibility of the platform in the future but, as of now, it's fairly locked-down.

Even writing documenting for the subjects listed, in regards to hacking the existing BookStack code, would take quite a while and would quickly become outdated.

@ssddanbrown commented on GitHub (Sep 27, 2019): Hi @NaLiJa, We currently do not provide, or really support, a way to implement plug-ins in this manner at all. We're looking to increase the extensibility of the platform in the future but, as of now, it's fairly locked-down. Even writing documenting for the subjects listed, in regards to hacking the existing BookStack code, would take quite a while and would quickly become outdated.

OVERLORD commented

2026-02-05 00:44:45 +03:00

@ssddanbrown commented on GitHub (Apr 1, 2020):

Since my last comment, I have set-up the following page in the docs:
https://www.bookstackapp.com/docs/admin/hacking-bookstack/

This provides a little more information to those that are a bit more adventurous. I probably won't go any further than that in terms of detail. Therefore I'll close this off.

@ssddanbrown commented on GitHub (Apr 1, 2020): Since my last comment, I have set-up the following page in the docs: https://www.bookstackapp.com/docs/admin/hacking-bookstack/ This provides a little more information to those that are a bit more adventurous. I probably won't go any further than that in terms of detail. Therefore I'll close this off.

OVERLORD referenced this issue

2026-02-05 03:24:05 +03:00

Button for "Next Page" #2229

Sign in to join this conversation.

Branches Tags

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/BookStack#1381