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

Make section headings more navigable #161

Open
victorlin opened this issue Jun 27, 2023 · 0 comments
Open

Make section headings more navigable #161

victorlin opened this issue Jun 27, 2023 · 0 comments
Labels
enhancement New feature or request

Comments

@victorlin
Copy link
Member

This was brought up in nextstrain/augur#1243 (comment) and also on Slack some time ago.

Currently, it's up to individual pages to provide a table of contents for navigation between sections of long pages. Example (rendered):

.. contents:: Table of Contents
:local:

A better solution would be something like a sidebar with interactive headings (example). This has the following benefits over the existing RTD-generated table of contents:

  1. It is always visible, even when clicking on a section heading and jumping to that part of the document.
  2. It highlights the currently visible part of the document.

These 2 features allow readers to know where they are in relation to the entire document and provides a better experience for documents with many headings/subheadings.

@victorlin victorlin added the enhancement New feature or request label Jun 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
No open projects
Development

No branches or pull requests

1 participant