mirror of
https://github.com/BookStackApp/BookStack.git
synced 2026-02-08 19:06:06 +03:00
Add support for live-rendered pictures from external providers #3840
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 @f-steff on GitHub (Jun 8, 2023).
Describe the feature you'd like
This is a feature request to add support for live-rendered pictures from external providers.
Two examples of external providers are Mermaid and PlantUML, who both have public renderers available, as well as allow private renderers to be set up. Other alternatives could be the good old visit counters.
For Mermaid an example URL, which contains the image to be rendered, could be:
https://mermaid.ink/img/pako:eNpVjstqw0AMRX9FaNVC_ANeFBq7zSbQQrPzZCFsOTMk80CWCcH2v3ccb1qtxD3nCk3Yxo6xxP4W760lUTjVJkCe96ay4gb1NJyhKN7mAyv4GPgxw_7lEGGwMSUXLq-bv18lqKbjqjGodeG6bKh69r8Cz1A3R0oa0_kvOd3jDB-N-7b5_H9ihXPrs-mp7KloSaAieSq4Q8_iyXX5_WlNDKplzwbLvHYkV4MmLNmjUePPI7RYqoy8wzF1pFw7ugj5LVx-AfLqVWg?type=pngSimilar, for PlantUML an example URL, which contains the image to be rendered, could be:
http://www.plantuml.com/plantuml/png/SoWkIImgAStDuNBAJrBGjLDmpCbCJbMmKiX8pSd9vt98pKi1IW80Essentially this should end up inserting
<img src="Provided_URL" />to the HTML of Bookstack, optionally with some WIDTH, HEIGHT, and ALT attributes.Describe the benefits this would bring to existing BookStack users
This would allow users to insert remotely generated graphic content.
For the examples, it would allow users to edit pictures directly in a live PlantUML or Mermaid editor, and save a link in Bookstack which contains everything to edit the picture.
Can the goal of this request already be achieved via other means?
Not that I have found.
Have you searched for an existing open/closed issue?
How long have you been using BookStack?
0 to 6 months
Additional context
The request differs from #566 Diagram/graph feature on wiki via markdown syntax and #495 Feature Request Math & UML in this is about adding a new image type where the rendered image is not cached in Bookstack.
@ssddanbrown commented on GitHub (Jun 8, 2023):
Hi @f-steff,
You can set the image URL of any existing image, alongside its width and height, via the "Image" icon shown at the right side of the toolbar when an image is selected in the editor, as show below:
Therefore you could insert another image like normal as a placeholder then swap out the URL for the image as required.
@ssddanbrown commented on GitHub (Dec 8, 2023):
Since a potential workaround was provided above, with no further follow up, I'll go ahead and close this off.
@pjbosco commented on GitHub (Dec 2, 2025):
Updating the "Image Select" dialog to accept either a link to an image or an uploaded image seems like a straight forward approach.