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 Antora's "Content" TOC to the preview #1230

Open
ahus1 opened this issue Nov 28, 2022 · 1 comment
Open

Add Antora's "Content" TOC to the preview #1230

ahus1 opened this issue Nov 28, 2022 · 1 comment

Comments

@ahus1
Copy link
Contributor

ahus1 commented Nov 28, 2022

Why the new feature should be added

On the rendered Antora website, each page has a "Content" TOC, which is currently not shown in the preview. For users who expect the preview to match the page, this comes as a surprise.

See https://antora.zulipchat.com/#narrow/stream/282400-users/topic/Intelli.20.22.3Atoc.3A.20left.22.20does.20not.20render.20the.20toc.20to.20the.20left.20in

How the new feature should work

This feature might be optional. On a smaller screen (less width) the contents could be collapsed -- although this would deviate from the preview of the real site.

@mojavelinux
Copy link
Member

If this is added, I strongly suggest tucking it away in either a dropdown or hamburger icon. I don't think the TOC should be shown in a separate column in a preview. That is just a tremendous waste of space that severally reduces the amount of content that can be previewed.

although this would deviate from the preview of the real site.

I don't think the preview should be emulating exactly what's in the real site. That's just not the point of a preview...and it will never be able to match completely anyway without rendering the entire site, which would just be such a waste.

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