Add table of content to static sites

[pikinier20]

No description provided.

[pikinier20]

I just realized that this approach won't work well if the section is longer than one page. This PR can't be merged until we fix it.

[julienrf]

@pikinier20 what do you mean by “the section longer than one page”?

The PR sounds like a great improvement :) Do you have a screenshot?

[pikinier20]

@pikinier20 what do you mean by “the section longer than one page”?

I mean that if the content of section is longer than one screen, then the javascript that highlights proper sections won't work. It checks if the header of section is present on page. With longer content, the header is invisible but the content is still on the screen.

[pikinier20]

@julienrf You can see how it looks here: https://scala3doc.virtuslab.com/pr-rhs-table-of-content/scala3/docs/reference/overview.html

[julienrf]

The table of contents overlaps with the “next page” link:

Do you know if there are examples of pages with sections of various levels (h1, h2, h3, etc.)?

[pikinier20]

The table of contents overlaps with the “next page” link:

Do you know if there are examples of pages with sections of various levels (h1, h2, h3, etc.)?

I've refactored the arrows since they were a bit inconsistent with the rest of the design. Right now, the anchors to previous and next page are located at the bottom of the page like in e.g. webhelp format.

[julienrf]

I find that the links to the previous and next pages are hard to see. Would it be possible to move them above the list of contributors, maybe?

[pikinier20]

I find that the links to the previous and next pages are hard to see. Would it be possible to move them above the list of contributors, maybe?

That's not that easy because contributors are added by another template :/

[pikinier20]

@julienrf I've moved the arrows above contributors

[julienrf]

Thank you Filip!

I think this is good to go.