Use of Docker to create mkdocs folder and conflict with github pages "master/docs"

[mdeliw]

I have two questions:

1. My org offers "master/docs" as publishing source for github pages. So I am assuming that my markdowns should be in a folder other than "docs" (say "src"), and my site output should be under "docs". Is this understanding true?

So per your documentation, the docker command to setup a folder to be mkdocs project:
docker run --rm -it -v ${PWD}:/docs squidfunk/mkdocs-material new .`
would create "docs" sub-folder under root to contain the sample index.md.

If I force this command to instead mount to "src" - that doesn't work, and I assumed this would create sample index.md under a "src" sub-folder.
docker run --rm -it -v ${PWD}:/src squidfunk/mkdocs-material new .`

So my understanding is wrong.

2. If I change the mkdocs.yml theme setting for docs_dir to point to "src" and site_dir to point "docs" - that should provide me the desired outcome right?

Given that the docker command only allows "docs" as the markdown folder, I have to manually fix the project structure.

[squidfunk]

No, /docs is just the name of the internal mount point. You can mount anything you like, but the current working directory seems to be the best option.

[mdeliw]

Thanks for the update. Either I am using the docker command mentioned in the reference incorrectly, or it is not working as expected. If /docs as internal mount point can be anything, then the following doesn't work:

docker run --rm -it -v ${PWD}:/src squidfunk/mkdocs-material new .

Now if I run the above with /docs and on the scaffolded project, rename /docs to /src, adjust the mkdocs.yml settings for docs_dir and site_dir:

then the following doesn't work either:
docker run --rm -it -v ${PWD}:/src squidfunk/mkdocs-material build

[squidfunk]

You can't change the mount point to ${PWD}/src. It needs to be ${PWD}/docs, as it's the working directory within the Docker image:

mkdocs-material/Dockerfile

Lines 70 to 71 in 73602b2

	# Set working directory
	WORKDIR /docs