How to setup mkdocs preview live server

[jklist]

Context

1.docker pull squidfunk/mkdocs-material
2.docker run --rm -it -v /www/wwwroot/Mkdocs:/docs squidfunk/mkdocs-material new .
3.docker run -itd --restart=always --name Mkdocs -v /www/wwwroot/Mkdocs:/docs -v /www/wwwroot/Mkdocs/tmp:/tmp -p 8000:8000 --workdir /docs squidfunk/mkdocs-material serve -a 0.0.0.0:8000

I used the above commands to create a website in docker. But I found that every time the container is restarted or stopped and then started again, it creates N folders in the corresponding /www/wwwroot/Mkdocs/tmp. A folder is generated every time it is started. Is there a bug?

Bug description

Related links

• Reporting a bug

Reproduction

none

Steps to reproduce

none

Browser

No response

Before submitting

• I have read and followed the bug reporting guidelines.
• I have attached links to the documentation, and possibly related issues and discussions.
• I assure that I have removed all customizations before submitting this bug report.
• I have attached a .zip file with a minimal reproduction using the built-in info plugin.

[jklist]

If you do not add -v /www/wwwroot/Mkdocs/tmp:/tmp, it will be generated in /tmp in the container.

[niclasheinz]

The command mkdocs serve command automatically recreates the documentation. The temporary build is saved under /tmp.

MkDocs comes with a built-in dev-server that lets you preview your documentation as you work on it. Make sure you're in the same directory as the mkdocs.yml configuration file, and then start the server by running the mkdocs serve command:
https://www.mkdocs.org/getting-started/

The command -v /www/wwwroot/Mkdocs/tmp:/tmp mounts the host directory /www/wwwroot/Mkdocs/tmp to the container's /tmp directory, allowing for shared access to files between the host and the Docker container.

Maybe you are looking for how to build mkdocs using Docker?

• Building your site: https://squidfunk.github.io/mkdocs-material/creating-your-site/#building-your-site

[jklist]

command 命令会自动重新创建文档。临时版本保存在 /tmp 下。mkdocs serve

MkDocs 带有一个内置的开发服务器，可让您在处理文档时预览文档。确保您与mkdocs.yml配置文件位于同一目录中，然后通过运行 mkdocs serve 命令启动服务器：https://www.mkdocs.org/getting-started/

也许您正在寻找如何使用 Docker 构建 mkdocs？

• 构建您的网站：https://squidfunk.github.io/mkdocs-material/creating-your-site/#building-your-site

I want to use docker to map the docs folder so that I can update and modify it at any time. How should I do this? Do I need to docker run --rm -it -v ${PWD}:/docs squidfunk/mkdocs-material build after each update?

[niclasheinz]

You can simply use
docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material

Docs: mkdocs-material/creating-your-site/#previewing-as-you-write

Run this command in the root folder of your project where mkdocs.yml is located.

Converting this to a discussion.

[niclasheinz]

Hi @jklist

I have written a bash script that automatically recognises the mkdocs-material docker container and then deletes the /tmp/mkdocs* folders in the docker container itself, except for the very last one.

[jklist]

Thank you. Is it built into the latest version?

[niclasheinz]

No, it is not integrated in the latest version. However, you can run this manually or via cronjob.