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 Prev and Next navigation buttons #1191

Open
AnderUstarroz opened this issue Mar 8, 2023 · 2 comments
Open

Add Prev and Next navigation buttons #1191

AnderUstarroz opened this issue Mar 8, 2023 · 2 comments
Labels
enhancement status: needs discussion Issues that need more discussion before they can be properly triaged.

Comments

@AnderUstarroz
Copy link

AnderUstarroz commented Mar 8, 2023

You did an absolutely amazing job building this template. I Just have one suggestion thought, I really miss having a Prev and Next navigation buttons for a smooth navigation between pages. I mean this can be done manually of course, but having the app already knowing the order of the pages, shouldn't be too hard adding an option on _config.yml to enable/disable navigation arrows (ideally with customized text)

Describe the solution you'd like
Adding < PREV and NEXT > navigation button support via _config.yml

Additional context
Examples from some famous project.

@pdmosses
Copy link
Contributor

pdmosses commented Mar 8, 2023

@AnderUstarroz thanks for raising this issue. See #394 (comment) for the status of some previous work towards addressing it.

I really miss having a Prev and Next navigation buttons for a smooth navigation between pages. I mean this can be done manually of course, but having the app already knowing the order of the pages, shouldn't be too hard […]

The navigation of a website is a tree, and a particular order of visiting the pages might not be suitable for all sites. The order on the site you cited is for Next to descend a level, and ascend only after visiting all the lower pages. That works well for such a shallow (two-level) site when the visitor is expected to visit all the pages in a particular order; putting the Next link at the bottom of the page also assumes the visitor wants to read it. But for a multi-level1 documentation site, the deepest pages might provide only supplementary details, of little or no interest to some visitors.

My personal preference is for the Prev and Next buttons to stay at the same level, and to provide an Up button for ascending in the navigation. This is what I use for my CBS-beta project.

So perhaps the order of visiting should be configurable.

You're welcome to submit a new PR for supporting Prev and Next buttons in v0.4, but I suggest to clarify the design first.

Footnotes

  1. Just the Docs v0.4 is restricted to three navigation levels. PR Multi-level navigation #462 proposes general multi-level navigation, but I won't have time to discuss or update it until late April.

@AnderUstarroz
Copy link
Author

mmh I think otherwise, being able to jump from one section to the next without having to use additional clicks for going up was really nice on Rust docs, but you made a valid point (some may not like it) therefore having a configurable behavior on _config.yml would make us all happy.

I don't think I'll be able to submit a PR any time soon, I am quite busy at the moment and I' would have to understand how this whole Jekyll template system works, but I'll try if I find some time.

Thanks for the quick answer.

@mattxwang mattxwang added the status: needs discussion Issues that need more discussion before they can be properly triaged. label Mar 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement status: needs discussion Issues that need more discussion before they can be properly triaged.
Projects
None yet
Development

No branches or pull requests

3 participants