-
Notifications
You must be signed in to change notification settings - Fork 921
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
Version pagelinks #1054
Version pagelinks #1054
Conversation
If the version_menu_pagelinks config option is true, then link in the drop-down menu of the versioned docs points to the current page in the other version, instead of the main page. This can be useful if the document doesn't change much between the different versions. Note that if the current page doesn't exist in the other version, the link will be broken.
I wonder is there a way for this to fail more elegantly - go to the main page of the versioned site if the specific URL isn't there? |
I don't think so, as there is no real way to check that the url exists - often the different versions are under different domains and different sites. |
This seems enormously useful even without the graceful failure mode. In our particular case, we could handle most 404s with server-side redirects. |
Ok, let's go with the current implementation for now, looks like people will find it useful! Thanks. |
Nice feature indeed. I'd consider failing more elegantly to be essential, so I've created an issue to track this: /cc @nate-double-u - navigate between versions is getting closer to being supported the way we need it :) |
* Allow versioned docs to point to the same page in the different versions If the version_menu_pagelinks config option is true, then link in the drop-down menu of the versioned docs points to the current page in the other version, instead of the main page. This can be useful if the document doesn't change much between the different versions. Note that if the current page doesn't exist in the other version, the link will be broken. * Adds version_menu_pagelinks to the userguide * Typo fix Co-authored-by: LisaFC <[email protected]>
If you set the
version_menu_pagelinks
parameter totrue
, then links in the version drop-dow menupoint to the current page in the other version, instead of the main page.
This can be useful if the document doesn't change much between the different versions.
Note that if the current page doesn't exist in the other version, the link will be broken.