mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2024-06-14 11:52:32 +03:00
setting-up-versioning.md: explain "stay on the same page" feature
While the feature is supposed to work out of the box, there are a few non-obvious conditions required for it to function.
This commit is contained in:
parent
9259251377
commit
fbf84de130
@ -56,6 +56,20 @@ Check out the versioning example to see it in action –
|
|||||||
[version example]: https://squidfunk.github.io/mkdocs-material-example-versioning/
|
[version example]: https://squidfunk.github.io/mkdocs-material-example-versioning/
|
||||||
[Why use mike?]: https://github.com/jimporter/mike#why-use-mike
|
[Why use mike?]: https://github.com/jimporter/mike#why-use-mike
|
||||||
|
|
||||||
|
### Stay on the same page when switching versions
|
||||||
|
|
||||||
|
When the user chooses a version in the version selector, they usually want to go
|
||||||
|
to the page corresponding to the page they were previously viewing. Material for
|
||||||
|
MkDocs implements this behavior by default, but there are a few caveats:
|
||||||
|
|
||||||
|
- the [`site_url`] must be set correctly in `mkdocs.yml`. See the ["Publishing a
|
||||||
|
new version"](#publishing-a-new-version) section for an example.
|
||||||
|
- you must be viewing the site at that URL (and not locally, for example).
|
||||||
|
- the redirect happens via JavaScript and there is no way to know which page you
|
||||||
|
will be redirected to ahead of time.
|
||||||
|
|
||||||
|
[`site_url`]: https://www.mkdocs.org/user-guide/configuration/#site_url
|
||||||
|
|
||||||
### Version warning
|
### Version warning
|
||||||
|
|
||||||
[:octicons-tag-24: 8.0.0][Version warning support] ·
|
[:octicons-tag-24: 8.0.0][Version warning support] ·
|
||||||
@ -135,7 +149,13 @@ mike deploy --push --update-aliases 0.1 latest
|
|||||||
```
|
```
|
||||||
|
|
||||||
Note that every version will be deployed as a subdirectory of your `site_url`,
|
Note that every version will be deployed as a subdirectory of your `site_url`,
|
||||||
e.g.:
|
which you should set explicitly. For example, if your `mkdocs.yml` contains:
|
||||||
|
|
||||||
|
``` yaml
|
||||||
|
site_url: 'https://docs.example.com/' # Trailing slash is recommended
|
||||||
|
```
|
||||||
|
|
||||||
|
the documentation will be published to URLs such as:
|
||||||
|
|
||||||
- _docs.example.com/0.1/_
|
- _docs.example.com/0.1/_
|
||||||
- _docs.example.com/0.2/_
|
- _docs.example.com/0.2/_
|
||||||
|
Loading…
Reference in New Issue
Block a user