Show table of contents within page editor #3778

Open
opened 2026-02-05 07:26:39 +03:00 by OVERLORD · 5 comments
Owner

Originally created by @LawssssCat on GitHub (May 4, 2023).

Describe the feature you'd like

Add a toc sidebar in md editor, so that you can more conveniently know where you are writing/changing and what you have written

image

Side request for markdown preview color syntax highlighting

By the way, markdown editor preview's code seems to have no color

image

Describe the benefits this would bring to existing BookStack users

you can more conveniently know where you are writing/changing and what you have written

Can the goal of this request already be achieved via other means?

no
i do not know how to view the directory structure until i save the page

Have you searched for an existing open/closed issue?

  • I have searched for existing issues and none cover my fundemental request

How long have you been using BookStack?

0 to 6 months

Additional context

System Version
BookStack v23.02.3

Originally created by @LawssssCat on GitHub (May 4, 2023). ### Describe the feature you'd like Add a toc sidebar in md editor, so that you can more conveniently know where you are writing/changing and what you have written ![image](https://user-images.githubusercontent.com/18041500/236252358-06a34acd-dc82-4f64-9c7c-2e0994a82117.png) <details><summary>Side request for markdown preview color syntax highlighting</summary> <p> By the way, markdown editor preview's code seems to have no color ![image](https://user-images.githubusercontent.com/18041500/236254776-c1dbb85d-c18b-4a11-9906-6fe53b168939.png) </p> </details> ### Describe the benefits this would bring to existing BookStack users you can more conveniently know where you are writing/changing and what you have written ### Can the goal of this request already be achieved via other means? no i do not know how to view the directory structure until i save the page ### Have you searched for an existing open/closed issue? - [X] I have searched for existing issues and none cover my fundemental request ### How long have you been using BookStack? 0 to 6 months ### Additional context System Version BookStack v23.02.3
OVERLORD added the 📝 WYSIWYG Editor> Markdown Editor🔨 Feature Request labels 2026-02-05 07:26:39 +03:00
Author
Owner

@ssddanbrown commented on GitHub (May 4, 2023):

Thanks for the request, I'm going to rename this to be editor generic since I look to align feature-sets across editors, especially for supporting elements like this.

I'll also remove the mention of the syntax/code color wording, since that's a completely separate point and is known/on-purpose, as we've chosen to prioritise performance/stability over syntax highlighting in this case (Since code syntax highlighting/rendering is perform via an additional component).

@ssddanbrown commented on GitHub (May 4, 2023): Thanks for the request, I'm going to rename this to be editor generic since I look to align feature-sets across editors, especially for supporting elements like this. I'll also remove the mention of the syntax/code color wording, since that's a completely separate point and is known/on-purpose, as we've chosen to prioritise performance/stability over syntax highlighting in this case (Since code syntax highlighting/rendering is perform via an additional component).
Author
Owner

@GuillaumeV-cemea commented on GitHub (Apr 8, 2024):

If anyone is interested, I've done a quick bookstack hack to display a clickable ToC inside the editor (in the comment tab).

The code (with screenshot example) is here : https://gitlab.cemea.org/-/snippets/4

It's not pretty, but it works :-)

@GuillaumeV-cemea commented on GitHub (Apr 8, 2024): If anyone is interested, I've done a quick bookstack hack to display a clickable ToC inside the editor (in the comment tab). The code (with screenshot example) is here : https://gitlab.cemea.org/-/snippets/4 It's not pretty, but it works :-)
Author
Owner

@faburem commented on GitHub (Dec 18, 2024):

+1 a table of contents would be a really useful feature!

@faburem commented on GitHub (Dec 18, 2024): +1 a table of contents would be a really useful feature!
Author
Owner

@Tomblarom commented on GitHub (Aug 6, 2025):

+1 I'd also love to have a table of contents.. This is how it looks within Clickup:

Image
@Tomblarom commented on GitHub (Aug 6, 2025): +1 I'd also love to have a table of contents.. This is how it looks within Clickup: <img width="901" height="762" alt="Image" src="https://github.com/user-attachments/assets/e65800c4-1e9c-4483-996f-0e49e7b1aea2" />
Author
Owner

@Tomblarom commented on GitHub (Aug 6, 2025):

@GuillaumeV-cemea thanks for the workaround! It seems to only work with the old WYSIWYG-Editor, not the one, that is currently in beta.

@Tomblarom commented on GitHub (Aug 6, 2025): @GuillaumeV-cemea thanks for the workaround! It seems to only work with the old WYSIWYG-Editor, not the one, that is currently in beta.
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/BookStack#3778