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 Content Navigation Bar in Right Side of Documentation pages #105

Closed
PIYUSHgoyal16 opened this issue Oct 5, 2020 · 6 comments · Fixed by #107
Closed

Add Content Navigation Bar in Right Side of Documentation pages #105

PIYUSHgoyal16 opened this issue Oct 5, 2020 · 6 comments · Fixed by #107

Comments

@PIYUSHgoyal16
Copy link
Contributor

The current documentation layout has no side navigation bar, and looks something like this:
Screenshot from 2020-10-05 23-41-37

As the content on the upcoming pages is increasing, navigation to each section is becoming harder. To deal with such a bulkier page, I could break the content into multiple pages, but that would reduce the charm as the user would be just navigating between pages(due to references). Hence, I propose to have a content navigation bar on the right side, utilising the vacant space, helping the reader to have a better experience.

@iramcdonald
Copy link
Collaborator

iramcdonald commented Oct 5, 2020 via email

@dheeraj135
Copy link
Member

@PIYUSHgoyal16 I think you want something like this: http://blog.pc.iitmandi.co.in/web-development-for-freshers/. If so, you only need to set toc : true and probably the toc_label. For reference: https://raw.githubusercontent.com/KamandPrompt/blog/master/_posts/2020-05-25-web-development-for-freshers.md

@dheeraj135
Copy link
Member

Official documentation for table of contents: https://mmistakes.github.io/minimal-mistakes/docs/helpers/#table-of-contents

@Signior-X
Copy link
Contributor

Should I try this one?

@PIYUSHgoyal16
Copy link
Contributor Author

PIYUSHgoyal16 commented Oct 6, 2020

@PIYUSHgoyal16 I think you want something like this: http://blog.pc.iitmandi.co.in/web-development-for-freshers/. If so, you only need to set toc : true and probably the toc_label. For reference: https://raw.githubusercontent.com/KamandPrompt/blog/master/_posts/2020-05-25-web-development-for-freshers.md

Thanks, @dheeraj135 :-)
But not exactly, I want the sidebar to remain intact even when the user scrolls down. Something like the left-hand side, the author profile in case of your example.

@PIYUSHgoyal16
Copy link
Contributor Author

Should I try this one?

Sure @Signior-X Do let us know if you are stuck somewhere :-)

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

Successfully merging a pull request may close this issue.

4 participants