mirror of
https://github.com/BookStackApp/BookStack.git
synced 2026-02-23 11:19:38 +03:00
Help buttons/links in markdown editor #1364
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 @ethanmdavidson on GitHub (Sep 13, 2019).
Describe the feature you'd like
On the markdown editor, I would like to have a link to some markdown help. It would also be nice to have some buttons which insert the markdown syntax for you.
Two examples of what I mean:
Gitlab markdown editor
Github markdown editor
Describe the benefits this feature would bring to BookStack users
For new users, the buttons would greatly ease the learning curve because the buttons provide a familiar UI, and the documentation would be right at their fingertips. It would also help more advanced users because it can be hard to remember all the different markdown syntax. The existing keyboard shortcuts are nice, but without a link to the documentation most people will never know they exist.
Additional context
This is related to #1661
@berot3 commented on GitHub (Jan 22, 2020):
Yes please! For me bookstack is not an option until the WYSIWYG-editor stores the pages as markdown and not as html.
It would be a "work-around" to use the markdown-editor. But than the markdown-way is not usable until at least there are some helper-buttons for editors.
@Technosoft2000 commented on GitHub (Apr 13, 2020):
👍 +1 to see this feature in future versions :)
@reda-i commented on GitHub (Apr 29, 2020):
👍 Really need this feature. Cannot adopt markdown as the default editor for all users if only those proficient in it can use it, or at least provide the option for different users to use different editors.
@TheNomad11 commented on GitHub (Jul 13, 2021):
Yes, please, or more shortcuts at least
@ssddanbrown commented on GitHub (Jul 13, 2021):
@TheNomad11 The markdown editor does support a range of shortcuts as listed here: https://www.bookstackapp.com/docs/user/markdown-editor/
@KatyPurry commented on GitHub (Sep 9, 2021):
A toolbar would be very useful for beginner !
@EmberLightVFX commented on GitHub (Apr 6, 2023):
Big +1 on having a toolbar for markdown!
I write markdown way faster than using the WYSIWYG editor and it's very easy to use markdown written somewhere else and just paste it into the editor and bam, you're done.
But I sometimes don't remember specific markdown commands like how to create tables or strike-throughs. I then have to go to https://www.markdownguide.org/ and search there until I find what i was looking for.
Having these added to the toolbar as shortcuts would help a lot for things the user don't remember.
Another reason is that we're multiple people writing on bookstack and having a toolbar would/may avoid switching from MD to WYSIWYG to MD to WYSIWYG etc... depending on who's writing and how good they are with MD.
Looking at the code from the now closed PR https://github.com/BookStackApp/BookStack/pull/3952 it doesn't look like that much extra code to support a feature like this.