Configuring mike 2.0 with mkdocs-material #6308
Replies: 1 comment
-
We managed to simply pass the argument directly during the docs publishing CI step: - name: Publish docs
run: |
git config user.name github-workflow-bot
git config user.email [email protected]
mike deploy --push --update-aliases ${{ github.ref_name }} latest --alias-type=redirect
mike set-default --push latest |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
Our documentation deployment stopped working since the release of mike 2.0. I believe it's because we are deploying using CI on Github Enterprise Server 3.8 which doesn't support symbolic links (the default setting for aliasing versions with mike 2.0).
There seems to be an option for mike to use the old method by setting its option alias_type to redirect/copy (pre 2.0 methods). This is normally set in mkdocs.yml through the plugins section, however the documentation for mkdocs-material specifies setting extra\version\provider:mike field instead for versioning docs.
Is there a way to pass the alias_type option within the extra section of mcdocs.yml to mike, or should I be using the plugin section instead? I presume that mike to the plugins section may not play nice with mkdocs-material, but I'm really not entirely sure how to fix this aside from rolling back to mike 1.x.
Beta Was this translation helpful? Give feedback.
All reactions