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

Just an idea (if possible) for the Learn section: list the headers of the content in the left menu #588

Open
FDelporte opened this issue Dec 19, 2023 · 2 comments

Comments

@FDelporte
Copy link
Collaborator

Two possible improvements:

  • Easy: change "Overview" to "Content" or "Learn"
  • In the left menu, under "Overview" (or "Learn"), list all the H1 ... H3 headers of the content, to show a clean structure of the content and provide anchor links directly to the right part of the content.

Screenshot 2023-12-19 at 17 00 57

@leewyatt
Copy link
Collaborator

Hi Frank,
That's a great idea!
Implementing the left sidebar navigation should be quite straightforward.
However, scrolling to a specific header upon clicking a navigation button might be a bit challenging. We'll need @FlorianKirmaier 's technical support since we render the markdown strings through JPro's MarkDownView. (As it stands, the entire document is treated as a single node.)

@FlorianKirmaier
Copy link
Collaborator

FlorianKirmaier commented Dec 22, 2023

  1. Providing Access to the "Chapter"
    Somehow, it already works. That's what we are doing in the https://www.jpro.one page.
    But I have to check whether the API for this is nice and clean.
  2. Adding Anchors
    It's more tricky - but it's time to write some form of anchor-api to the routing.

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

No branches or pull requests

3 participants