Skip to content

Commit 82db310

Browse files
committed
Explain how to use the container
Signed-off-by: Davide Cavalca <davide@cavalca.name>
1 parent 5c174f5 commit 82db310

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,10 @@ This is the [Asahi Linux documentation](https://asahilinux.org/docs/) repository
44

55
## Usage
66

7-
This is made with [MkDocs](https://www.mkdocs.org/). Run `make build` to build the site, or `make test` to spin up a local webserver for review. The website is rebuilt by the CI on every commit and served via GitHub Pages.
7+
This is made with [MkDocs](https://www.mkdocs.org/). If you have mkdocs installed already, run `make build` to build the site, or `make test` to spin up a local webserver for review. If you don't, feel free to use our [container](https://github.com/AsahiLinux/docs/pkgs/container/mkdocs-asahi) with something like:
8+
9+
```
10+
$ podman run -it --pull=newer -p=8000:8000 -v=$(pwd)/:/docs:z ghcr.io/asahilinux/mkdocs-asahi:latest
11+
```
12+
13+
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)