Confusion about Mike support in mkdocs-material

[Andre601]

Not sure if this is intentional behaviour, or if I have to alter something to adjust my docs and make everything work as it should.

Right now I have a single "branch" set up in Mike called dev which is updated using the action shared in #4759.

The thing is, that on the actual docs, the Version selector is not visible. The dev branch is present and can be accessed by appending /dev to the URL itself. However, this causes the "Outdated" banner to show, even tho I doubt that this should be the case as dev is by definition the latest push of the documentation.

So I would appreciate some assistance in understanding how Mike works here and if I had to do anything specific to correct all this...

[squidfunk]

Did you set dev as a default version?

mike set-default --push dev

[Andre601]

I've set a different branch as default using set-default, tho it doesn't redirect when targetting the root.
Could perhaps be that I didn't push using --push

What I wonder is how commands in gh action should look like...
Right now I have mike deploy --push dev as command.
I assume it should be changed to

mike deploy dev
mike set-default dev --push

to be sure that it keeps the default.

[squidfunk]

Related: #4759.

[Andre601]

Related: #4759.

I did mention that issue. Doesn't really answer my point

[squidfunk]

Sorry, missed it. I'm answering dozens of questions a day, so sometimes it's hard to keep context all the time. In general, I think it's best to ask the maintainers of mike then.

[Andre601]

Yeah, the set-default command doesn't really work here, which is rather strange. I've opened an issue on the Mike repository and will wait for a reply.

In the meantime am I curious how MkDocs-material determines the page to be "old". Is it a check provided from mike or is there some internal logic applied from you using the provided versions.json file?

[Andre601]

I now tried to define multiple default branches like this:

extra:
  version:
    provider: mike
    default:
      - latest
      - dev

But even tho I have dev as the default defined is MkDocs Material still giving me the Outdated banner while being on the dev branch.
Could this be related to caching?

GitHub Pages is used to host the content and I update the page on push like this:

name: Deploy Site

on:
  workflow_dispatch:
  push:
    paths:
      - 'docs/**'
      - 'mkdocs.yml'
      - 'mkdocs-theme/**'
      - 'requirements.txt'
    branches:
      - master
    tags-ignore:
      - '**'

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
        with:
          fetch-depth: 0
      - name: Set up Python 3.7
        uses: actions/setup-python@v4
        with:
          python-version: 3.7
      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip setuptools
          python -m pip install -r requirements.txt
      - name: Deploy Files
        run: |
          git config user.name "github-actions[bot]"
          git config user.email "[email protected]"
          mike deploy dev
          mike set-default dev --push

[MartinHugh]

I have also run into a problem with the version selector not showing.
It works OK when being run under mike server, but if I try to create a static file (PDF or html) there is no version selector.
What am I missing ?

[kamilkrzyskow]

The version toggle is implemented in client-side JavaScript/TypeScript. The PDF plugin generates a file from the HTML so there won't be a version number in the header if that's what you're looking for.

The HTML doesn't include the mike versioning toggle, just the config information about the default etc., and the JavaScript loads the versions.json file located at the root of the deployment to later inject the version indicator based on the contents of the JSON file. You can look at the example from the docs:
https://github.com/squidfunk/mkdocs-material-example-versioning/blob/gh-pages/versions.json

You need to provide more information about your project structure, mike configurations and the commands you run, aka a minimal reproduction: https://squidfunk.github.io/mkdocs-material/guides/creating-a-reproduction/ if you want more help.