Skip to content

Commit

Permalink
Add support for mike 2.0.0
Browse files Browse the repository at this point in the history
The default setting in this version utilizes symbolic links for aliases,
which aren't compatible with GitHub Pages. Therefore, we must specify the
use of redirect aliases.

To do this, we set the `alias_type` to redirect within the mike plugin
configuration in the `mkdocs.yml` file.

Signed-off-by: Tiyash Basu <[email protected]>
  • Loading branch information
tiyash-basu-frequenz committed Nov 6, 2023
1 parent d63b57e commit e7c14d6
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ plugins:
- literate-nav:
nav_file: SUMMARY.md
- mike:
alias_type: redirect
canonical_version: latest
- mkdocstrings:
custom_templates: templates
Expand Down

0 comments on commit e7c14d6

Please sign in to comment.