Skip to content

Commit 8b1592e

Browse files
committed
Add command for docker, explain submodules
Signed-off-by: Davide Cavalca <davide@cavalca.name>
1 parent 82db310 commit 8b1592e

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,12 @@ This is made with [MkDocs](https://www.mkdocs.org/). If you have mkdocs installe
1010
$ podman run -it --pull=newer -p=8000:8000 -v=$(pwd)/:/docs:z ghcr.io/asahilinux/mkdocs-asahi:latest
1111
```
1212

13+
if you're using [Podman](https://podman.io), or
14+
15+
```
16+
$ docker run -it --pull=always -p=8000:8000 -v=$(pwd)/:/docs:z ghcr.io/asahilinux/mkdocs-asahi:latest
17+
```
18+
19+
if you're using [Docker](https://www.docker.com). Note that this repository uses [Git Submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules), so you'll want to set those up first with `git submodule update --init`.
20+
1321
The website is rebuilt by the CI on every commit and served via GitHub Pages. The container is also automatically updated and pushed to the registry.

0 commit comments

Comments
 (0)