From efbd2284724b01bf7e1db0c9137a9367b9bb321e Mon Sep 17 00:00:00 2001 From: squidfunk Date: Sat, 2 Apr 2022 14:09:11 +0200 Subject: [PATCH] Documentation --- docs/creating-your-site.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/creating-your-site.md b/docs/creating-your-site.md index 0fae341dd..275846d02 100644 --- a/docs/creating-your-site.md +++ b/docs/creating-your-site.md @@ -235,6 +235,20 @@ files with: mkdocs build ``` +If you're running Material for MkDocs from within Docker, use: + +=== "Unix, Powershell" + + ``` + docker run --rm -it -v ${PWD}:/docs squidfunk/mkdocs-material build + ``` + +=== "Windows" + + ``` + docker run --rm -it -v "%cd%":/docs squidfunk/mkdocs-material build + ``` + The contents of this directory make up your project documentation. There's no need for operating a database or server, as it is completely self-contained. The site can be hosted on [GitHub Pages], [GitLab Pages], a CDN of your choice