Skip to content

Commit

Permalink
Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
squidfunk committed May 15, 2024
1 parent cc398dd commit 3a27c80
Showing 1 changed file with 18 additions and 4 deletions.
22 changes: 18 additions & 4 deletions docs/setup/setting-up-versioning.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,14 +61,13 @@ 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.
- the [`site_url`][mkdocs.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

<!-- md:version 8.0.0 -->
Expand Down Expand Up @@ -131,6 +130,21 @@ redirected to.
[Version warning preview]: ../assets/screenshots/version-warning.png
[default version]: #setting-a-default-version

### Version alias

<!-- md:version 9.5.23 -->
<!-- md:default `false` -->

If you're using aliases for versioning, and want to show the version alias
besides the version number, you can enable this feature by setting the `alias`
option to `true`:

``` yaml
extra:
version:
alias: true
```

## Usage

While this section outlines the basic workflow for publishing new versions,
Expand Down

0 comments on commit 3a27c80

Please sign in to comment.