general: add build instructions

This commit is contained in:
eggy 2020-09-24 21:13:22 -04:00
parent 7a168dac62
commit 92af85986c

View File

@ -5,3 +5,18 @@ A "competitor" of sorts to magicalsoup/highschool.
Please note that the clone link is incorrect; it should be `https://git.eggworld.tk/eggy/eifueo.git`. Please note that the clone link is incorrect; it should be `https://git.eggworld.tk/eggy/eifueo.git`.
The LaTeX formatting in this repository uses `$...$` for inline math, and `$$...$$` for multi-line math. The LaTeX formatting in this repository uses `$...$` for inline math, and `$$...$$` for multi-line math.
## Dependencies
- `mkdocs`
- `mkdocs-material`
- `mkdocs-material-extensions`
- `python-markdown-math`
## Build instructions
MkDocs is used to build the site.
```
mkdocs build
```