From c8631f448367ce9422576ba164805874dfa008d9 Mon Sep 17 00:00:00 2001 From: eggy Date: Thu, 24 Sep 2020 21:13:22 -0400 Subject: [PATCH] general: add build instructions --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 6fad346..7489787 100644 --- a/README.md +++ b/README.md @@ -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. 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 +```