Keyboard shortcuts (Not inside the editor) #985

New Issue

OVERLORD · 2026-02-04T23:16:44+03:00

OVERLORD commented

2026-02-04 23:16:44 +03:00

Originally created by @andreicocari on GitHub (Jan 12, 2019).

Describe the feature you'd like
I know there are shortcuts available inside the editor, but I'd love to see more added outside of the text editor. For example

"E" to edit a page, chapter, book, (depending which screen you're on)
"N" to create a new page
"C" to create a new chapter
"M to move
SHIFT + DEL to delete
etc

Describe the benefits this feature would bring to BookStack users
This will greatly increase productivity.

Originally created by @andreicocari on GitHub (Jan 12, 2019). **Describe the feature you'd like** I know there are shortcuts available inside the editor, but I'd love to see more added outside of the text editor. For example - "E" to edit a page, chapter, book, (depending which screen you're on) - "N" to create a new page - "C" to create a new chapter - "M to move - SHIFT + DEL to delete - etc **Describe the benefits this feature would bring to BookStack users** This will greatly increase productivity.

OVERLORD added the 🛠️ Enhancement ☕ Open to discussion 💆 UX 💻 Front-End labels 2026-02-04 23:16:44 +03:00

OVERLORD closed this issue

2026-02-04 23:16:47 +03:00

OVERLORD commented

2026-02-04 23:16:51 +03:00

@ssddanbrown commented on GitHub (Jan 13, 2019):

Thanks for the suggestion @andreicocari.

Related to #1198.

Would be good to get a list of shortcuts to implement, then close off this issue once complete. Then, if any extras are needed in the future new issues can be opened.

I'll leave this open to receive shortcut suggestions and maintain a list in this comment. I've removed the delete shortcut, think I'd prefer not to have shortcuts for destructive operations, They should be fairly infrequent anyway.

I wonder if the new page shortcut should be P instead of N to follow convention better?

Proposed Shortcuts

"E" - Edit the current page/chapter/book/shelf
"N" - Create new page
"C" - Create a new chapter
"M" - Move
"F" - Focus on global search box (Find)

@ssddanbrown commented on GitHub (Jan 13, 2019): Thanks for the suggestion @andreicocari. Related to #1198. Would be good to get a list of shortcuts to implement, then close off this issue once complete. Then, if any extras are needed in the future new issues can be opened. I'll leave this open to receive shortcut suggestions and maintain a list in this comment. I've removed the delete shortcut, think I'd prefer not to have shortcuts for destructive operations, They should be fairly infrequent anyway. I wonder if the new page shortcut should be P instead of N to follow convention better? --- ### Proposed Shortcuts - "E" - **E**dit the current page/chapter/book/shelf - "N" - Create **n**ew page - "C" - Create a new **c**hapter - "M" - **M**ove - "F" - Focus on global search box (**F**ind)

OVERLORD commented

2026-02-04 23:16:54 +03:00

@andreicocari commented on GitHub (Jan 14, 2019):

Hi Dan,

Thanks for considering my request.

I can see how "P" would make sense, however I was hoping to have "N" as the default new X action.
For instance, in the "Shelves" screen, "N" would create a new shelf, while in the "Book" screen, it would create a new book. Now, I believe that "Pages" are the default go-to inside of a book, therefore it should have the default shortcut.

Hope this makes sense?

@andreicocari commented on GitHub (Jan 14, 2019): Hi Dan, Thanks for considering my request. I can see how "P" would make sense, however I was hoping to have "N" as the default new X action. For instance, in the "Shelves" screen, "N" would create a new shelf, while in the "Book" screen, it would create a new book. Now, I believe that "Pages" are the default go-to inside of a book, therefore it should have the default shortcut. Hope this makes sense?

OVERLORD commented

2026-02-04 23:16:58 +03:00

@andreicocari commented on GitHub (Aug 6, 2019):

They've been implementing Confluence at work.
Figured I'd share their Keyboard Shortcuts as Inspiration

@andreicocari commented on GitHub (Aug 6, 2019): They've been implementing Confluence at work. Figured I'd share their [Keyboard Shortcuts](https://developer.atlassian.com/server/confluence/images/keyboard-shortcuts-example.png) as Inspiration

OVERLORD commented

2026-02-04 23:17:04 +03:00

@ssddanbrown commented on GitHub (Aug 18, 2019):

Just adding an implementation note, Will need to consider accessibility:

https://www.w3.org/WAI/WCAG21/Understanding/character-key-shortcuts.html

@ssddanbrown commented on GitHub (Aug 18, 2019): Just adding an implementation note, Will need to consider accessibility: https://www.w3.org/WAI/WCAG21/Understanding/character-key-shortcuts.html

OVERLORD commented

2026-02-04 23:17:14 +03:00

@GreatestFool commented on GitHub (Jun 22, 2020):

Didn't notice this issue when I first posted my own, so I'll just include my suggestion here since it was closed as a potential duplicate.

BookStack is already going for the Bookshelf > Book > Chapter > Page aesthetic anyway, so for an end-user case, I think accesskey navigation would be nice. So that you can move between chapters, and pages under each chapter, using your arrow keys or similar.

@ssddanbrown pointed out to me that many users probably already use the arrow keys for navigation or similar anyway, so perhaps something like shift or control plus arrow keys instead of direct access would be better? I've seen sites use comma and period as a back and forward button, so that's also an option.

@GreatestFool commented on GitHub (Jun 22, 2020): Didn't notice this issue when I first posted my own, so I'll just include my suggestion here since it was closed as a potential duplicate. BookStack is already going for the Bookshelf > Book > Chapter > Page aesthetic anyway, so for an end-user case, I think accesskey navigation would be nice. So that you can move between chapters, and pages under each chapter, using your arrow keys or similar. @ssddanbrown pointed out to me that many users probably already use the arrow keys for navigation or similar anyway, so perhaps something like shift or control plus arrow keys instead of direct access would be better? I've seen sites use comma and period as a back and forward button, so that's also an option.

OVERLORD commented

2026-02-04 23:17:20 +03:00

@sdenovan commented on GitHub (Oct 21, 2020):

As a recent Confluence convert, I'm thrilled with BookStack but really miss the 'e'dit shortcut. While this feature request matures, here's a stopgap to get the 'e'dit shortcut today.

Settings -> Custom HTML Head Content

<script src="//cdnjs.cloudflare.com/ajax/libs/mousetrap/1.6.5/mousetrap.min.js"></script>
<script>
  Mousetrap.bind('e', function(e) {
    if (window.location.href.includes('/page/') && !window.location.href.endsWith('/edit')) {
      window.location.href=window.location.href+'/edit';
    }
  });
</script>

@sdenovan commented on GitHub (Oct 21, 2020): As a recent Confluence convert, I'm thrilled with BookStack but really miss the 'e'dit shortcut. While this feature request matures, here's a stopgap to get the 'e'dit shortcut today. Settings -> Custom HTML Head Content ``` <script src="//cdnjs.cloudflare.com/ajax/libs/mousetrap/1.6.5/mousetrap.min.js"></script> <script> Mousetrap.bind('e', function(e) { if (window.location.href.includes('/page/') && !window.location.href.endsWith('/edit')) { window.location.href=window.location.href+'/edit'; } }); </script> ```

OVERLORD commented

2026-02-04 23:17:26 +03:00

@HermasciousLevander commented on GitHub (Jan 12, 2021):

BookStack is already going for the Bookshelf > Book > Chapter > Page aesthetic anyway, so for an end-user case, I think accesskey navigation would be nice. So that you can move between chapters, and pages under each chapter, using your arrow keys or similar.

@ssddanbrown pointed out to me that many users probably already use the arrow keys for navigation or similar anyway, so perhaps something like shift or control plus arrow keys instead of direct access would be better? I've seen sites use comma and period as a back and forward button, so that's also an option.

Just a little thought about this, considering the apprehension for taking permanent control over the accesskeys could simply be a config setting. If it is left as disabled by default, people like me will still be able to make use of it instead of using potential hacky solutions to do it.

Personally, I prefer Ctrl + left or right accesskey to navigate.

@HermasciousLevander commented on GitHub (Jan 12, 2021): > BookStack is already going for the Bookshelf > Book > Chapter > Page aesthetic anyway, so for an end-user case, I think accesskey navigation would be nice. So that you can move between chapters, and pages under each chapter, using your arrow keys or similar. > > @ssddanbrown pointed out to me that many users probably already use the arrow keys for navigation or similar anyway, so perhaps something like shift or control plus arrow keys instead of direct access would be better? I've seen sites use comma and period as a back and forward button, so that's also an option. Just a little thought about this, considering the apprehension for taking permanent control over the accesskeys could simply be a config setting. If it is left as disabled by default, people like me will still be able to make use of it instead of using potential hacky solutions to do it. Personally, I prefer `Ctrl` + left or right accesskey to navigate.

OVERLORD commented

2026-02-04 23:17:29 +03:00

@florian-obradovic commented on GitHub (Oct 21, 2022):

I also come from Confluence (use it at work).
I use Bookstack since 2 years for my private and freelancer IT Documentation and I'm still hitting E on my keyboard to enter editor when reading a page :)

It would be awesome to see some more hot keys.

Keep up the great work. Thank you very much!

@florian-obradovic commented on GitHub (Oct 21, 2022): I also come from Confluence (use it at work). I use Bookstack since 2 years for my private and freelancer IT Documentation and I'm still hitting **E** on my keyboard to enter editor when reading a page :) It would be awesome to see some more hot keys. Keep up the great work. Thank you very much!

OVERLORD commented

2026-02-04 23:17:35 +03:00

@ssddanbrown commented on GitHub (Nov 10, 2022):

UI Shortcut system added via PR #3830. Will be part of the next feature release.

@ssddanbrown commented on GitHub (Nov 10, 2022): UI Shortcut system added via PR #3830. Will be part of the next feature release.

OVERLORD commented

2026-02-04 23:17:41 +03:00

@florian-obradovic commented on GitHub (Dec 6, 2022):

Thank you very much for this awesome release - I love it!

@florian-obradovic commented on GitHub (Dec 6, 2022): Thank you very much for this awesome release - I love it!

Sign in to join this conversation.

Branches Tags

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/BookStack#985