Add custom formats to editor #1009

Closed
opened 2026-02-04 23:23:50 +03:00 by OVERLORD · 3 comments
Owner

Originally created by @ezzra on GitHub (Jan 28, 2019).

I don't know if this is already possible, but I would like to use custom formats in the editor.

screenshot_2019-01-28_13-02-20

For example something fancy blinking stuff or whatever the admins want to set up for their users.

Originally created by @ezzra on GitHub (Jan 28, 2019). I don't know if this is already possible, but I would like to use custom formats in the editor. ![screenshot_2019-01-28_13-02-20](https://user-images.githubusercontent.com/37742522/51835209-f93ae400-22fc-11e9-8fa6-fbeb00d22acc.png) For example something `fancy blinking stuff` or whatever the admins want to set up for their users.
OVERLORD added the 🌔 Out of scope📝 WYSIWYG Editor🔨 Feature Request labels 2026-02-04 23:23:50 +03:00
Author
Owner

@ghost commented on GitHub (Mar 4, 2019):

Im also interested in this feature. Did you succeded in adding a new format?

@ghost commented on GitHub (Mar 4, 2019): Im also interested in this feature. Did you succeded in adding a new format?
Author
Owner

@Pyselcongor commented on GitHub (Oct 10, 2020):

It would be great to be able to add custom format or to be able to at least modify the default ones (font color, underlined etc...)

Edit: You can actualy modify the default Formats thanks to the Custom Header in the settings. For example:

<style>
.page-content h3 {color: #3366ff !important;}
.page-content h4 {color: #008080; text-decoration: underline; !important;}
</style>

Giving :
image

@Pyselcongor commented on GitHub (Oct 10, 2020): It would be great to be able to add custom format or to be able to at least modify the default ones (font color, underlined etc...) Edit: You can actualy modify the default Formats thanks to the Custom Header in the settings. For example: ``` <style> .page-content h3 {color: #3366ff !important;} .page-content h4 {color: #008080; text-decoration: underline; !important;} </style> ``` Giving : ![image](https://user-images.githubusercontent.com/26470678/95654435-44604f00-0b00-11eb-998a-20d4b487771a.png)
Author
Owner

@ssddanbrown commented on GitHub (Jan 30, 2022):

I'm going to close this off as it's not something I'd be looking to support directly in the core project, especially with the somewhat minimal demand.

My work in https://github.com/BookStackApp/BookStack/issues/2738#issuecomment-1022683101 has enforced the idea for me that we need to stick to a standard format to ensure maintainability and portability of content. That said I will still aim to expose points of extension where feasible to allow customizations to those that really desire/need it, they just won't be so adverse to being impacted by updates/changes.

For example, the Custom HTML head can be used to style some existing formats as shown above.
The WYSIWYG editor config can be tweaked via some events we emit as shown here:
https://www.bookstackapp.com/docs/admin/hacking-bookstack/#bookstack-editor-events
(Note, These events will likely change soon as we change up the editor).

@ssddanbrown commented on GitHub (Jan 30, 2022): I'm going to close this off as it's not something I'd be looking to support directly in the core project, especially with the somewhat minimal demand. My work in https://github.com/BookStackApp/BookStack/issues/2738#issuecomment-1022683101 has enforced the idea for me that we need to stick to a standard format to ensure maintainability and portability of content. That said I will still aim to expose points of extension where feasible to allow customizations to those that really desire/need it, they just won't be so adverse to being impacted by updates/changes. For example, the Custom HTML head can be used to style some existing formats as shown above. The WYSIWYG editor config can be tweaked via some events we emit as shown here: https://www.bookstackapp.com/docs/admin/hacking-bookstack/#bookstack-editor-events (Note, These events will likely change soon as we change up the editor).
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/BookStack#1009