general: add build instructions
This commit is contained in:
parent
7a168dac62
commit
92af85986c
15
README.md
15
README.md
@ -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
|
||||||
|
```
|
||||||
|
Loading…
Reference in New Issue
Block a user