mirror of
https://github.com/BookStackApp/BookStack.git
synced 2026-02-09 19:06:13 +03:00
Add plugin/module support #116
Reference in New Issue
Block a user
Delete Branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Originally created by @bridgeyuwa on GitHub (Jun 15, 2016).
I am suggesting an API for plugins/modules should be developed to encourage extention of bookstack functionality according to need by laravel developers
@patoroco commented on GitHub (Feb 9, 2017):
What plugins are you suggesting?
@hotgeart commented on GitHub (Aug 4, 2017):
@patoroco I would like to have templates/skeletons for the doc. At the moment we just have one template.
Title
Content
That's would be awesome to have the possibility to create custom fields so if you create a doc for an item in the cartegory A before to create the page you can chose a template.
@foinus commented on GitHub (May 1, 2018):
WEB api to Create documentation automatically based on other systems
@NickeZ commented on GitHub (Jun 11, 2018):
It would be great if you added extensibility / plug-in capabilities to BookStack so that dynamic content from other databases can be displayed. See for example confluence and documize.
EDIT: To be more clear, it should be easy for someone hosting a BookStack app to install/remove in-house developed plug-ins / user macros.
@MadddinTribleD commented on GitHub (Jun 25, 2018):
I thought about adding support for up/downvoting aticles or books. Something like the system of GitHub.
Would be nice if i could just bundle it up in a plugin and throw in a folder or something along those lines.
@n0nag0n commented on GitHub (Jan 28, 2019):
Or a plugin to auto sort pages/chapters. Or a plugin to allow the markdown editor to have a "helper" of sorts, something like SimpleMDE (https://simplemde.com/) where bulleted lists are much easier to auto type the next line.
@DavidCardoso commented on GitHub (Apr 3, 2019):
Or a plugin to allow users to mark favorite items (pages, books, etc).
@ssddanbrown commented on GitHub (Apr 20, 2019):
Just copying in my response from #1373 since it's relevant for anyone wanting an update on some sort of official plugin system.
Are plugins planned?
Short Answer: No
Long Answer: Kind of. The REST API item on the roadmap is really just intended to cover an externally accessible way to perform actions and fetch content from BookStack for the purpose of extension, connection and automation.
For interface-based stuff we'll have the theming system, which already exists but is undocumented and unstable. This allows you to make overrides on a selective, per-blade-view level basis. There's still a fair bit of view changes I want to do to before documenting this and I'm looking to make the application JS functionality more accessible. (Let me know if you want details of using this system if you have not already found it).
I think the REST API and theming system combined will introduce loads of possibilities for extension and customization.
In terms of offering the ability to add pre-packaged "plug-ins", that customize both UI and functionality, This is something I'm not really looking to implement/support right now for the following reasons:
Don't get me wrong though, I can totally see why people would want a plugin system but, for the above reasons, I don't think It's something the project can support at this stage of its life.
Once the REST API and theme system have bedded-in for a little while I'd imagine we'd look to integrate those bits a little further to empower development-minded folks that want to dig a little deeper but I'd be hesitant of brand that as a "Plugin-in" system as it'll open things up to my points above as it'll attract less-technically capable users.
I hope that provides some insight!
@gchamon commented on GitHub (Jun 16, 2021):
Addons/plugins could be handy to delegate custom functionality to parties interested and keep the team focused on the core of bookstack. Support for added features using custom addons would be delegated to maintainers of said addon, and not the core team.
Use-Case
@ssddanbrown commented on GitHub (Jun 16, 2021):
Since my last message here was a couple of years ago now, I'll just confirm that since that last message there's now the:
/api/docson your instance).@timosystems commented on GitHub (Jun 7, 2023):
is there any plan to add modules/plugins for the integration of external content?
For example, i want to add a diagram from diagrams.net
Ofc, i can go to diagrams.net, then draw my diagram there, export it as .png image and import it again on bookstackapp.
But this has several drawbacks.
Other example, i want to add a table from onlyoffice, collabora, etc.
Ofc i can just copy and paste the table and it could be converted into a html table, but again:
I do understand that those examples are not a core feature of bookstackapp. and thats exactly WHY i think its good to support plugins, to make good additions possible without having to code them by yourself/your team.
@ssddanbrown commented on GitHub (Jun 7, 2023):
@timosystems
Just to confirm, we have diagrams.net integration built-in, including editing of existing created drawings. Details here.
You can embed external content via the "Insert/Edit Media" toolbar button. This is largely iframe based (And you'd need to adjust BookStack security settings to allow certain hosts to be iframed into pages).
Other than that, not really as per my comments above but the methods of extension/customization listed in my previous comment may evolve and eventually be wrapped up into a plugin system.
We already have more formalised examples of using the existing systems on our hacks page.
@Grazouillis commented on GitHub (May 12, 2025):
It could be nice to have a module which allows the validation for a workflow project.
If you have any purpose about this, I'm interested. :)