Build/Deploy via Docker?

[bimCelum]

Hi!

We've been using mkdocs-material for almost 2 years for our knowledge-base, but since mkdocs-material is in maintenance mode now, we are evaluating whether to switch to MaterialX or Zensical. MaterialX would be vastly preferred, as our project setup is quite complex.

Our knowledgebase is build with docker and deployed to an Azure static website, so I tried to do the same with MaterialX.

Current (mkdocs-material) Dockerfile:

FROM squidfunk/mkdocs-material:9
RUN pip install mkdocs-include-markdown-plugin markdown-include mkdocs-glightbox mkdocs-exclude-search mkdocs-open-in-new-tab

When changing the first line to FROM jaywhj/mkdocs-materialx:10, the following error is thrown during build:

ERROR: failed to build: failed to solve: jaywhj/mkdocs-materialx:10: failed to resolve source metadata for docker.io/jaywhj/mkdocs-materialx:10: pull access denied, repository does not exist or may require authorization: server message: insufficient_scope: authorization failed

In the documentation for MaterialX https://jaywhj.github.io/mkdocs-materialx/getting-started.html, there is no mention of installing MaterialX with Docker (like there is for the regular mkdocs-material).

Is this no longer possible? Or if it is possible, how would the commands look in the Dockerfile?

[jaywhj]

Due to time constraints, I haven't yet provided a separate Docker image repository for MaterialX, so it has been temporarily omitted from the documentation.
However, you can directly use the Material image. After pulling the image, install MaterialX first:

FROM squidfunk/mkdocs-material:9.7.1

RUN pip install --upgrade mkdocs-materialx

# Then install other plugins
…

The sequence is:

1. Pull the Docker image
2. Install MaterialX
3. Install other plugins

Or simply change it to the following method:

FROM squidfunk/mkdocs-material:9.7.1

RUN pip install --no-cache-dir \
    mkdocs-materialx \
    mkdocs-include-markdown-plugin \
    markdown-include \
    mkdocs-glightbox \
    mkdocs-exclude-search \
    mkdocs-open-in-new-tab

[bimCelum]

Thank you so much :)

[jaywhj]

@bimCelum

The official docker image has been released, see https://jaywhj.github.io/mkdocs-materialx/installation#with-docker