You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+9-4
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,4 @@
1
1
# Asahi Linux documentation repository
2
-
3
2
This is the [Asahi Linux documentation](https://asahilinux.org/docs/) repository.
4
3
5
4
## Documentation structure
@@ -21,7 +20,10 @@ Our documentation is organised into categories.
21
20
22
21
## Usage
23
22
24
-
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:
23
+
This is made with [MkDocs](https://www.mkdocs.org/). If you have mkdocs installed
24
+
already, run `make build` to build the site, or `make test` to spin up a local webserver
25
+
for review. If you don't, feel free to use our [container](https://github.com/AsahiLinux/docs/pkgs/container/mkdocs-asahi)
26
+
with something like:
25
27
26
28
```
27
29
$ podman run -it --pull=newer -p=8000:8000 -v=$(pwd)/:/docs:z ghcr.io/asahilinux/mkdocs-asahi:latest
@@ -33,6 +35,9 @@ if you're using [Podman](https://podman.io), or
33
35
$ docker run -it --pull=always -p=8000:8000 -v=$(pwd)/:/docs:z ghcr.io/asahilinux/mkdocs-asahi:latest
34
36
```
35
37
36
-
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`.
38
+
if you're using [Docker](https://www.docker.com). Note that this repository uses
39
+
[Git Submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules), so you'll
40
+
want to set those up first with `git submodule update --init`.
37
41
38
-
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.
42
+
The website is rebuilt by the CI on every commit and served via GitHub Pages.
43
+
The container is also automatically updated and pushed to the registry.
0 commit comments