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

Add table of content pane #182

Open
marszub opened this issue Jul 25, 2024 · 2 comments
Open

Add table of content pane #182

marszub opened this issue Jul 25, 2024 · 2 comments

Comments

@marszub
Copy link

marszub commented Jul 25, 2024

On the most common screen resolution i.e. 1920x1080 there is plenty of space on the sides of current content. Auto-generated table of content (TOC) that floats while scrolling the actual content would be very useful for navigation. It can be another toggle in server configuration. Since <!-- TOC --> tag is already supported, the TOC on the side can be generated the same way including links to headers. The TOC files should not be saved in the documentation dir to not create mess.

@DannyBen
Copy link
Owner

I will look into it. If implemented, it would probably be a setting to determine the position of the HTML snippet generated with <!-- TOC -->. Most likely be a CSS class added to this block that will make it float instead of part of the page.

@DannyBen
Copy link
Owner

I have looked into this, it is less straight forward than I thought, since the inline table of contents is added as markdown, and not as HTML (therefore, I cannot apply an HTML class to it to let it float at will).

We can keep this issue open for now, but at this point, I do not see it happening.

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

No branches or pull requests

2 participants