Switch between Markdown and WYSIWYG when editing pages #681

Closed
opened 2026-02-04 21:49:10 +03:00 by OVERLORD · 10 comments
Owner

Originally created by @pommetjehorlepiep on GitHub (May 16, 2018).

Desired Feature:

I'd love to be able to switch between Markdown & WYSIWYG when editing pages.

Much better than: go into the settings, change the editing mode and edit page(s) and once finished go back in settings to set mode back again.

Originally created by @pommetjehorlepiep on GitHub (May 16, 2018). Desired Feature: I'd love to be able to switch between Markdown & WYSIWYG when editing pages. Much better than: go into the settings, change the editing mode and edit page(s) and once finished go back in settings to set mode back again.
OVERLORD added the 🛠️ Enhancement label 2026-02-04 21:49:10 +03:00
Author
Owner

@ffub commented on GitHub (May 18, 2018):

I would also like this. This functionality is handled well in a number of static site editors such as https://www.siteleaf.com/

@ffub commented on GitHub (May 18, 2018): I would also like this. This functionality is handled well in a number of static site editors such as https://www.siteleaf.com/
Author
Owner

@ssddanbrown commented on GitHub (May 19, 2018):

Thanks for opening this feature request.

This is very closely related to #119 and #458.

@ffub Have you seen any more complex editors that do this? Many I've seen are really built markdown-first so are fairly limited to just the core markdown formattings options. Just something that includes tables & text alignment and possibly custom formats.

@ssddanbrown commented on GitHub (May 19, 2018): Thanks for opening this feature request. This is very closely related to #119 and #458. @ffub Have you seen any more complex editors that do this? Many I've seen are really built markdown-first so are fairly limited to just the core markdown formattings options. Just something that includes tables & text alignment and possibly custom formats.
Author
Owner

@ffub commented on GitHub (May 26, 2018):

Realistically, switching between WYSIWYG and Markdown will mean storing the
file in the latter.

Toast UI allows for tables and code blocks.

I think a limited set of semantic elements and a storage format such as
Markdown is a benefit. It keeps pages from ending up full of junk HTML copy
and pasted from webpages and word processors.

The only elements that I think are handled poorly by Markdown are images. I
pretty much always want to add a caption to an image, and the


element is a really clean way to handle them in running text.

On 19 May 2018 at 15:25, Dan Brown notifications@github.com wrote:

Thanks for opening this feature request.

This is very closely related to #119
https://github.com/BookStackApp/BookStack/issues/119 and #458
https://github.com/BookStackApp/BookStack/issues/458.

@ffub https://github.com/ffub Have you seen any more complex editors
that do this? Many I've seen are really built markdown-first so are fairly
limited to just the core markdown formattings options. Just something that
includes tables & text alignment and possibly custom formats.


You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
https://github.com/BookStackApp/BookStack/issues/842#issuecomment-390408520,
or mute the thread
https://github.com/notifications/unsubscribe-auth/AADjOrgBY3rOONCDzUj6TpuyCUr7Vt9kks5t0Ct3gaJpZM4UAkhs
.

@ffub commented on GitHub (May 26, 2018): Realistically, switching between WYSIWYG and Markdown will mean storing the file in the latter. Toast UI allows for tables and code blocks. I think a limited set of semantic elements and a storage format such as Markdown is a benefit. It keeps pages from ending up full of junk HTML copy and pasted from webpages and word processors. The only elements that I think are handled poorly by Markdown are images. I pretty much always want to add a caption to an image, and the <figure> element is a really clean way to handle them in running text. On 19 May 2018 at 15:25, Dan Brown <notifications@github.com> wrote: > Thanks for opening this feature request. > > This is very closely related to #119 > <https://github.com/BookStackApp/BookStack/issues/119> and #458 > <https://github.com/BookStackApp/BookStack/issues/458>. > > @ffub <https://github.com/ffub> Have you seen any more complex editors > that do this? Many I've seen are really built markdown-first so are fairly > limited to just the core markdown formattings options. Just something that > includes tables & text alignment and possibly custom formats. > > — > You are receiving this because you were mentioned. > Reply to this email directly, view it on GitHub > <https://github.com/BookStackApp/BookStack/issues/842#issuecomment-390408520>, > or mute the thread > <https://github.com/notifications/unsubscribe-auth/AADjOrgBY3rOONCDzUj6TpuyCUr7Vt9kks5t0Ct3gaJpZM4UAkhs> > . >
Author
Owner

@NickeZ commented on GitHub (Jun 11, 2018):

XWiki allows the author of the document to switch between markup formats in a lossy way.

@NickeZ commented on GitHub (Jun 11, 2018): [XWiki](http://extensions.xwiki.org/xwiki/bin/view/Extension/Markdown%20Syntax%201.2) allows the author of the document to switch between markup formats in a lossy way.
Author
Owner

@JHenneberg commented on GitHub (Apr 30, 2019):

The TOAST ui editor looks realy promising.

Markdown Wysiwyg Editor - Productive and Extensible
Live Preview, Scrolling, Syn, Auto indent, Syntax highlight

It looks also very similar to the currently used one. You can edit either in markdown or in the WYSIWYG.
https://ui.toast.com/tui-editor

alt

alt

alt

@JHenneberg commented on GitHub (Apr 30, 2019): The TOAST ui editor looks realy promising. Markdown Wysiwyg Editor - Productive and Extensible Live Preview, Scrolling, Syn, Auto indent, Syntax highlight It looks also very similar to the currently used one. You can edit either in markdown or in the WYSIWYG. https://ui.toast.com/tui-editor ![alt](https://user-images.githubusercontent.com/1215767/34353629-95b58da0-ea6c-11e7-859b-df5e990dd157.png) ![alt](https://user-images.githubusercontent.com/1215767/34354737-b98a0736-ea73-11e7-8375-d4c83b8894d8.png) ![alt](https://user-images.githubusercontent.com/1215767/34354831-5f04c7e6-ea74-11e7-9664-97f71c4fee6e.png)
Author
Owner

@tlnagy commented on GitHub (Jul 14, 2019):

The TOAST ui editor looks realy promising.

This would be amazing. I think I'll have a much easier time convincing my group to use the markdown version of the wiki if it included some WYSIWYG features. Right now there's a trade-off: portability in markdown mode and discoverability/convenience in WYSIWYG mode.

@tlnagy commented on GitHub (Jul 14, 2019): > The TOAST ui editor looks realy promising. This would be amazing. I think I'll have a much easier time convincing my group to use the markdown version of the wiki if it included some WYSIWYG features. Right now there's a trade-off: portability in markdown mode and discoverability/convenience in WYSIWYG mode.
Author
Owner

@GammaGames commented on GitHub (Jun 24, 2020):

I've actually used toast in projects, it's very good. I have the option to switch between the WYSIWYG editor and the regular markdown editor so it's easy for anyone to use how they want.

@GammaGames commented on GitHub (Jun 24, 2020): I've actually used toast in projects, it's very good. I have the option to switch between the WYSIWYG editor and the regular markdown editor so it's easy for anyone to use how they want.
Author
Owner

@kayvanaarssen commented on GitHub (Nov 24, 2020):

This would be awesome. We use this in our Wordpress KB as well

@kayvanaarssen commented on GitHub (Nov 24, 2020): This would be awesome. We use this in our Wordpress KB as well
Author
Owner

@Dalarialus commented on GitHub (Jan 19, 2022):

I'd really like to see this happen as well. I think that the ability to switch between markdown and WYSIWYG during editing would really help to balance functionality with ease of use.

@Dalarialus commented on GitHub (Jan 19, 2022): I'd really like to see this happen as well. I think that the ability to switch between markdown and WYSIWYG during editing would really help to balance functionality with ease of use.
Author
Owner

@ssddanbrown commented on GitHub (Apr 24, 2022):

PR #3387 has now been merged, which allows switching of editor type (If role permissions allow) from within the editor.
The editor type is then saved against the page itself, and uses the system setting as a default.
A preview can be seen here.

This isn't as instant as front-end switching (As per something like ToastUI) since we swap editor implementation depending on choice and we need to show a confirmation due to fundamental impacts of changing the editor. But it should be a lot faster and friendlier than current approaches, to cover most fundamental needs of this request.

There are two choices when moving from WYSIWYG to Markdown:

  • Stable - This retains existing HTML content in Markdown to avoid any potential functionality breakages or loss of formatting. This is similar to switching the global option now then re-opening a page for edit.
  • Clean - This is a system-cleaned markdown output, which is much nicer but has potential for formatting loss and potential functionality breaks (Things depending on HTML attributes/IDs for example).

The code for this has been merged and is targeted for the next feature release (Likely v22.04), So I'll therefore close this issue off.

@ssddanbrown commented on GitHub (Apr 24, 2022): PR #3387 has now been merged, which allows switching of editor type (If role permissions allow) from within the editor. The editor type is then saved against the page itself, and uses the system setting as a default. [A preview can be seen here. ](https://user-images.githubusercontent.com/8343178/164977916-9c8beee1-8578-43cd-b877-accb55e97fb6.mp4) This isn't as instant as front-end switching (As per something like ToastUI) since we swap editor implementation depending on choice and we need to show a confirmation due to fundamental impacts of changing the editor. But it should be a lot faster and friendlier than current approaches, to cover most fundamental needs of this request. There are two choices when moving from WYSIWYG to Markdown: - Stable - This retains existing HTML content in Markdown to avoid any potential functionality breakages or loss of formatting. This is similar to switching the global option now then re-opening a page for edit. - Clean - This is a system-cleaned markdown output, which is much nicer but has potential for formatting loss and potential functionality breaks (Things depending on HTML attributes/IDs for example). The code for this has been merged and is targeted for the next feature release (Likely v22.04), So I'll therefore close this issue off.
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/BookStack#681