Some Github pages deployment questions.

[kevindecapite]

I'm using the included GitHub Actions method of publishing my MkDocs to GitHub pages per the docs:

https://squidfunk.github.io/mkdocs-material/publishing-your-site/

My .github/workflows/ci.yml file has the following in it:

name: ci

on:
  push:
    branches:
      - master

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: actions/setup-python@v2
        with:
          python-version: 3.x
      - run: pip install mkdocs-material
      - run: mkdocs gh-deploy --force

This method of deployment is about 99% effective at the moment as there are 2 items that are not quite working:

1. For some reason my left sidebar navigation doesn't show on GH pages. I don't understand why it wouldn't show on GH pages while showing just fine in my local Docker version. Has anyone else seen this? Both GH and Docker are on the same commit.

2. I have my GitHub Pages settings for this repository configured to use a custom domain. However, every time I deploy, this value is removed from my GH Pages settings and I have to reconfigure it to make the site accessible again. What can I do about this behavior, if anything?

Otherwise I love using MkDocs and greatly appreciate its availability. Cheers.

[squidfunk]

1. Is the menu hamburger icon (top left) visible, i.e. does the sidebar collapse into the drawer which is also shown on mobile?) Did you maybe zoom into the page?
2. I believe you have to create a CNAME file and add it to your repository

[kevindecapite]

I understand, but of course it's only in the deployment that I'm seeing the problem. Locally everything works fine.

If you can point me in the right direction for diagnosing this, that may be helpful.

[squidfunk]

Make sure that you have the same versions and try to reproduce it without Docker. It's likely some config edge case that wasn't considered. If we know what it is and how it reproduces locally without Docker, we can fix it.

[kevindecapite]

The problem is in the navigation.tabs feature. If I remove that, the left sidebar loads just fine. Here's a way to reproduce the issue (sans Docker):

mkdocs.yml

site_name: Test

theme:
  features:
    - navigation.tabs
  name: material

[squidfunk]

Thanks! I see now what you're aiming for. The tabs behavior was changed a few releases ago in order to allow nav entries and links to bee rendered as tabs. See #2125 (comment) for an explanation and possible solution.

The difference in behavior you got locally and in CI was likely due to different versions.

There's also a footnote in the docs on this topic.

[kevindecapite]

Yes that's it. I was using an image from pre-December 2020. Once I updated it I'm now getting the same behavior in my Docker environment that I'm seeing in the production one. Of course, I see now this is the intended behavior so I'll just accommodate my docs implementation accordingly.

Thank you again for your attention and help with this.