Show table of contents within page editor

LawssssCat commented

2023-05-04 17:36:34 +02:00

(Migrated from github.com)

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

Side request for markdown preview color syntax highlighting

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

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

### 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

👍 6

ssddanbrown commented

2023-05-04 17:47:13 +02:00

(Migrated from github.com)

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).

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).

👍 2

GuillaumeV-cemea commented

2024-04-08 18:07:12 +02:00

(Migrated from github.com)

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 :-)

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 :-)

👍 3

faburem commented

2024-12-18 09:42:29 +01:00

(Migrated from github.com)

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

👍 3

Tomblarom commented

2025-08-06 14:47:08 +02:00

(Migrated from github.com)

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

+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" />

Tomblarom commented

2025-08-06 14:54:04 +02:00

(Migrated from github.com)

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

😕 1

Saturo78 commented

2026-02-18 08:14:54 +01:00

(Migrated from github.com)

Why not place the table of contents in the editor on the left sidebar, just like in the reading view? There is plenty of space there. Especially with long texts, the table of contents is indispensable if you need to jump around in the document or want to find your way around.