Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Help buttons/links in markdown editor #1663

Open
ethanmdavidson opened this issue Sep 13, 2019 · 7 comments
Open

Help buttons/links in markdown editor #1663

ethanmdavidson opened this issue Sep 13, 2019 · 7 comments

Comments

@ethanmdavidson
Copy link

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
gitlabMarkdownButtons

Github markdown editor
githubEditor

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
Copy link

berot3 commented 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
Copy link

👍 +1 to see this feature in future versions :)

@reda-i
Copy link

reda-i commented 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
Copy link

Yes, please, or more shortcuts at least

@ssddanbrown
Copy link
Member

Yes, please, or more shortcuts at least

@TheNomad11 The markdown editor does support a range of shortcuts as listed here: https://www.bookstackapp.com/docs/user/markdown-editor/

@KatyPurry
Copy link

KatyPurry commented Sep 8, 2021

A toolbar would be very useful for beginner !

@EmberLightVFX
Copy link

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 #3952 it doesn't look like that much extra code to support a feature like this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

8 participants