eggy/eifueo
1
1
Fork 1
Code Issues 2 Pull Requests Releases Wiki Activity

general: add build instructions

Browse Source
This commit is contained in:
eggy 2020-09-24 21:13:22 -04:00
parent 89c43eb584
commit c8631f4483
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -5,3 +5,18 @@ A "competitor" of sorts to magicalsoup/highschool.
The LaTeX formatting in this repository uses `$...$` for inline math, and `$$...$$` for multi-line math. MathJax is used to render this LaTeX. The LaTeX formatting in this repository uses `$...$` for inline math, and `$$...$$` for multi-line math. MathJax is used to render this LaTeX.
Admonitions can be added with documentation available [here](https://squidfunk.github.io/mkdocs-material/reference/admonitions/#usage). Admonitions can be added with documentation available [here](https://squidfunk.github.io/mkdocs-material/reference/admonitions/#usage).
## Dependencies
- `mkdocs`
- `mkdocs-material`
- `mkdocs-material-extensions`
- `python-markdown-math`
## Build instructions
MkDocs is used to build the site.
```
mkdocs build
```