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

Adding secondary chapter navigation on left side like just-the-docs jekyll theme #2273

Open
2 tasks done
amatya-aditya opened this issue Mar 13, 2024 · 5 comments
Open
2 tasks done

Comments

@amatya-aditya
Copy link

Have you checked that your feature request isn't already filed?

  • I read through FAQ and searched through the past issues, none of which addressed my feature request.
  • Yes, I have checked that this feature request isn't already filed.

Description & Motivation

This will be particularly helpful for making complete chapter-based notes, and exercises, for the specific book. So, If I want to open notes for specific books, I will have chapter navigation on the left sidebar and the table of contents on the right sidebar.

image

Pitch

No response

Alternatives

No response

Additional context

No response

@george-gca
Copy link
Collaborator

I don't think I understand. The chapter navigation is basically a toc. What would be the difference?

@amatya-aditya
Copy link
Author

Although both serve a similar purpose of helping users navigate through content, the key distinction lies in the organization of content. While a toc typically outlines the content within each chapter, chapter navigation involves structuring each chapter as a separate markdown file. This approach ensures that each chapter remains self-contained, enhancing clarity and organization by avoiding the clutter of mixing everything in a single file. Essentially, chapter navigation simplifies accessing and managing individual chapters while maintaining a coherent structure throughout the document.

TOC serves a better purpose for blogs and single markdown files, but if we are to write a different chapter for the book, it would be easier if all my chapters could be navigated easily. I hope this clears the differences.

Please look at this: Chapter and TOC navigation

@amatya-aditya
Copy link
Author

And also this : Separate chapter and toc navigation

@george-gca
Copy link
Collaborator

Now I get it. This can be currently achieved manually, but I agree that it would be good if it was integrated somehow.

@george-gca
Copy link
Collaborator

Adding another reference here.

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