AppFlowy-IO/AppFlowy

Fork 0

mirror of https://github.com/AppFlowy-IO/AppFlowy.git synced 2026-03-24 04:46:56 +00:00

[GH-ISSUE #3521] [FR] Table of contents for documents #1592

New issue

Open

opened 2026-03-23 20:51:26 +00:00 by mirror · 14 comments

mirror commented

2026-03-23 20:51:26 +00:00

Owner

Originally created by @tio-trom on GitHub (Sep 24, 2023).
Original GitHub issue: https://github.com/AppFlowy-IO/AppFlowy/issues/3521

Description

Would be very useful to have a table of contents based on the Headings of a document. This way you can structure a document better. This can be added to a right pane.

Impact

For long documents it is essential to be able to jump to "chapters", that can be represented with "headings" in markdown.

Additional Context

No response

Originally created by @tio-trom on GitHub (Sep 24, 2023). Original GitHub issue: https://github.com/AppFlowy-IO/AppFlowy/issues/3521 ### Description Would be very useful to have a table of contents based on the Headings of a document. This way you can structure a document better. This can be added to a right pane. ### Impact For long documents it is essential to be able to jump to "chapters", that can be represented with "headings" in markdown. ### Additional Context _No response_

mirror added the

organization

2025

labels

2026-03-23 20:51:26 +00:00

mirror commented

2026-03-23 20:51:27 +00:00

Author

Owner

@LucasXu0 commented on GitHub (Sep 25, 2023):

@tio-trom Do you mean the outline block?

@LucasXu0 commented on GitHub (Sep 25, 2023): @tio-trom Do you mean the outline block? ![image](https://github.com/AppFlowy-IO/AppFlowy/assets/11863087/2c503759-101d-453e-98b6-897148ad644e)

mirror commented

2026-03-23 20:51:27 +00:00

Author

Owner

@tio-trom commented on GitHub (Sep 25, 2023):

I mean something like Zettlr has:

Where the Headings become "chapters" and when you click one it scrolls to it. If you know what I mean.

@tio-trom commented on GitHub (Sep 25, 2023): I mean something like Zettlr has: ![2023-09-25_03-50](https://github.com/AppFlowy-IO/AppFlowy/assets/38043315/c8683ed2-3344-4de3-ab3e-924ad840c3ce) Where the Headings become "chapters" and when you click one it scrolls to it. If you know what I mean.

mirror commented

2026-03-23 20:51:28 +00:00

Author

Owner

@LucasXu0 commented on GitHub (Sep 25, 2023):

Where the Headings become "chapters" and when you click one it scrolls to it. If you know what I mean.

I believe the outline block is precisely what you're looking for, but it's currently displayed on the page instead of in the sidebar.

https://github.com/AppFlowy-IO/AppFlowy/assets/11863087/efc27b34-f542-466f-b7ef-673753997a47

@LucasXu0 commented on GitHub (Sep 25, 2023): > Where the Headings become "chapters" and when you click one it scrolls to it. If you know what I mean. I believe the outline block is precisely what you're looking for, but it's currently displayed on the page instead of in the sidebar. https://github.com/AppFlowy-IO/AppFlowy/assets/11863087/efc27b34-f542-466f-b7ef-673753997a47

mirror commented

2026-03-23 20:51:28 +00:00

Author

Owner

@tio-trom commented on GitHub (Sep 25, 2023):

Ahhh ok...yes that's what I meant, but positioning it like that makes it less efficient if you want to have a quick access you have to always scroll up. Would make more sense in a separate tab or at least a scroll to top icon somewhere.

@tio-trom commented on GitHub (Sep 25, 2023): Ahhh ok...yes that's what I meant, but positioning it like that makes it less efficient if you want to have a quick access you have to always scroll up. Would make more sense in a separate tab or at least a scroll to top icon somewhere.

mirror commented

2026-03-23 20:51:28 +00:00

Author

Owner

@emmggi commented on GitHub (Sep 25, 2023):

It makes a lot more sense to me, from a practical standpoint, to have it in a panel. A block would be useful when exporting to a PDF or similar.

@emmggi commented on GitHub (Sep 25, 2023): It makes a lot more sense to me, from a practical standpoint, to have it in a panel. A block would be useful when exporting to a PDF or similar.

mirror commented

2026-03-23 20:51:29 +00:00

Author

Owner

@LucasXu0 commented on GitHub (Sep 26, 2023):

Would make more sense in a separate tab or at least a scroll to top icon somewhere.
Sounds reasonable.

I see. @tio-trom @emmggi so do you prefer to display the characters on the panel or the sidebar rather than in the document?

@LucasXu0 commented on GitHub (Sep 26, 2023): > Would make more sense in a separate tab or at least a scroll to top icon somewhere. Sounds reasonable. I see. @tio-trom @emmggi so do you prefer to display the characters on the panel or the sidebar rather than in the document?

mirror commented

2026-03-23 20:51:29 +00:00

Author

Owner

@tio-trom commented on GitHub (Sep 26, 2023):

Would make more sense in a separate tab or at least a scroll to top icon somewhere.
Sounds reasonable.

I see. @tio-trom @emmggi so do you prefer to display the characters on the panel or the sidebar rather than in the document?

I think it makes a lot more sense. It is helpful to jump to sections in a document. If you put it at the top you always have to scroll up to then jump to certain sections.

@tio-trom commented on GitHub (Sep 26, 2023): > > Would make more sense in a separate tab or at least a scroll to top icon somewhere. > > Sounds reasonable. > > I see. @tio-trom @emmggi so do you prefer to display the characters on the panel or the sidebar rather than in the document? I think it makes a lot more sense. It is helpful to jump to sections in a document. If you put it at the top you always have to scroll up to then jump to certain sections.

mirror commented

2026-03-23 20:51:29 +00:00

Author

Owner

@emmggi commented on GitHub (Sep 29, 2023):

@LucasXu0 I'm not sure about the design. I think having a separate panel for outline that can be toggled on/off makes most sense.

@emmggi commented on GitHub (Sep 29, 2023): @LucasXu0 I'm not sure about the design. I think having a separate panel for outline that can be toggled on/off makes most sense.

mirror commented

2026-03-23 20:51:29 +00:00

Author

Owner

@YBYCS commented on GitHub (Dec 14, 2023):

I also really need this feature.

@YBYCS commented on GitHub (Dec 14, 2023): I also really need this feature.

mirror commented

2026-03-23 20:51:29 +00:00

Author

Owner

@annieappflowy commented on GitHub (Dec 16, 2023):

@YBYCS , did you mean having the outline floated on a separate panel?

@annieappflowy commented on GitHub (Dec 16, 2023): @YBYCS , did you mean having the outline floated on a separate panel?

mirror commented

2026-03-23 20:51:30 +00:00

Author

Owner

@YBYCS commented on GitHub (Dec 16, 2023):

@YBYCS , did you mean having the outline floated on a separate panel?

Yes, I believe this contributes to efficiency.

@YBYCS commented on GitHub (Dec 16, 2023): > @YBYCS , did you mean having the outline floated on a separate panel? Yes, I believe this contributes to efficiency.

mirror commented

2026-03-23 20:51:30 +00:00

Author

Owner

@dandv commented on GitHub (Dec 8, 2024):

Having the table of contents in a panel would make navigation easier than if it was only at the top of the document.

Consider how much easier it is to navigate among pages in Notion given they are displayed in a tree on the left side. If that tree were at the top and scrolled out, you'd have to scroll up to the top every time you wanted to navigate somewhere.

Notion also displays an automatic table of contents on the right.

In the same vein, editors have a "preview" of the file lines in the right pane.

@dandv commented on GitHub (Dec 8, 2024): Having the table of contents in a panel would make navigation easier than if it was only at the top of the document. Consider how much easier it is to navigate among pages in Notion given they are displayed in a tree on the left side. If that tree were at the top and scrolled out, you'd have to scroll up to the top every time you wanted to navigate somewhere. Notion also displays an automatic table of contents on the right. In the same vein, editors have a "preview" of the file lines in the right pane.

mirror commented

2026-03-23 20:51:30 +00:00

Author

Owner

@Yacine-Benali commented on GitHub (Dec 25, 2024):

Yeah this feature is a must for me especially when dealing with big documents. its the only thing preventing me from migrating form obsidian right now

@Yacine-Benali commented on GitHub (Dec 25, 2024): Yeah this feature is a must for me especially when dealing with big documents. its the only thing preventing me from migrating form obsidian right now

mirror commented

2026-03-23 20:51:30 +00:00

Author

Owner

@zhaob1n commented on GitHub (Feb 18, 2025):

Would make more sense in a separate tab or at least a scroll to top icon somewhere.
Sounds reasonable.

I see. @tio-trom @emmggi so do you prefer to display the characters on the panel or the sidebar rather than in the document?

I suggest a toggleable sidebar from the right, similar to the current left side bar.

@zhaob1n commented on GitHub (Feb 18, 2025): > > Would make more sense in a separate tab or at least a scroll to top icon somewhere. > > Sounds reasonable. > > I see. [@tio-trom](https://github.com/tio-trom) [@emmggi](https://github.com/emmggi) so do you prefer to display the characters on the panel or the sidebar rather than in the document? I suggest a toggleable sidebar from the right, similar to the current left side bar.

mirror referenced this issue

2026-03-23 22:16:03 +00:00

[PR #1592] [MERGED] test: fix integration test #4839