Use doc front matter to customize pagination

[Josh-Cena]

🚀 Feature

An option to hide specific pagination buttons, and repoint pagination links to other doc pages.

Have you read the Contributing Guidelines on issues?

Yes

Has this been requested on Canny?

https://docusaurus.io/feature-requests/p/allow-for-non-linear-navigation kind of points to this

Motivation

To allow for non-linear navigation; also related to #5686 because this will be used home pages where navigation doesn't make sense

API Design

• pagination_next: my-doc (a doc ID)
• pagination_prev: my-doc
• pagination_next: null (disable pagination)
• pagination_prev: null

Have you tried building it?

Yes, using swizzling and adding CSS to hide pagination; but repointing links would require editing on the plugin side

[slorber]

It shouldn't be hard to add.

I'm not 100% sure to understand the use-case though.

If a doc is already in the sidebar then there's linear navigation in the sidebar already, so why only disable this linear navigation at the bottom of the doc but not in the sidebar?

If the doc shouldn't have any linear navigation then hiding both the sidebar + the bottom nav may make sense, in which case the user can use a sidebar doc ref instead?

[Josh-Cena]

If a doc is already in the sidebar then there's linear navigation in the sidebar already, so why only disable this linear navigation at the bottom of the doc but not in the sidebar?

The sidebar is not linear; the sidebar is a tree structure.

For example, in that Canny request, the OP is doing something like "category: installation; items: Windows, Mac, Linux". In this case, after browsing "Installation > Windows", the user should be taken directly to the next step (e.g. configuration), not "Installation > Mac".

If the doc shouldn't have any linear navigation then hiding both the sidebar + the bottom nav may make sense, in which case the user can use a sidebar doc ref instead?

In fact, as I described in #5686, the "home page doc" should have the sidebar but without pagination, hope that makes sense

[slorber]

For example, in that Canny request, the OP is doing something like "category: installation; items: Windows, Mac, Linux". In this case, after browsing "Installation > Windows", the user should be taken directly to the next step (e.g. configuration), not "Installation > Mac".

Makes sense, agree we should add this.

Does it make sense to also allow arbitrary links for next/previous?
For example, you could want the first doc previous button to link to your homepage, and your last doc next button to link to some other standalone page? (in this case frontmatter would need a link+label)

(I still think that we should handle a "docId" shortcut because it's likely the most common use-case, supporting an object syntax in yaml can be supported later anyway)

[Josh-Cena]

Does it make sense to also allow arbitrary links for next/previous?

I just propose we use doc IDs as next/previous :P Makes the implementation / validation so much easier. We can allow arbitrary links later maybe, but IMO it doesn't make much sense

[slorber]

Agree, let's keep it simple for now, as long as we keep the ability to improve later without breaking changes