From c6cbde12886ab469137b15048b5dfc3ce784cce7 Mon Sep 17 00:00:00 2001 From: Ben Phelps Date: Fri, 29 Sep 2023 21:41:09 +0300 Subject: [PATCH] add docs to readme --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 293895c35..3bdff8022 100644 --- a/README.md +++ b/README.md @@ -140,7 +140,21 @@ pnpm dev Open [http://localhost:3000](http://localhost:3000) to start. -This is a [Next.js](https://nextjs.org/) application, see their documentation for more information: +This is a [Next.js](https://nextjs.org/) application, see their documentation for more information. + +# Documentation + +Homepage uses Material for MkDocs for documentation. To run the documentation locally, first install the dependencies: + +```bash +pip install -r requirements.txt +``` + +Then run the development server: + +```bash +mkdocs serve # or build, to build the static site +``` # Support & Suggestions