Skip to content

Commit 948e08a

Browse files
committed
Add build instructions
Signed-off-by: Davide Cavalca <davide@cavalca.name>
1 parent a6c307c commit 948e08a

File tree

3 files changed

+19
-2
lines changed

3 files changed

+19
-2
lines changed

Diff for: .gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
site/

Diff for: Makefile

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
help:
2+
@echo "Run 'make test' to test locally or 'make build' to render the static site"
3+
4+
build:
5+
mkdocs build
6+
7+
clean:
8+
rm -rf site
9+
10+
test:
11+
mkdocs serve
12+
13+
.PHONY: help build test

Diff for: README.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
## Asahi Linux documentation repository
1+
# Asahi Linux documentation repository
22

3-
This repo used to be a dummy placeholder to host the [documentation wiki](https://github.com/asahilinux/docs/wiki). It is now being converted into mkdocs.
3+
This is the [Asahi Linux documentation](https://asahilinux.org/docs/) repository.
44

5+
## Usage
6+
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.

0 commit comments

Comments
 (0)