From 254c4dec3b95df6afac3c34cf0165229a9c2cc52 Mon Sep 17 00:00:00 2001 From: InsanusMokrassar Date: Sun, 11 Jun 2023 08:51:16 +0600 Subject: [PATCH] Update README.md --- README.md | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1dc6372..4ef0e3b 100644 --- a/README.md +++ b/README.md @@ -1 +1,25 @@ -# docs \ No newline at end of file +# docs + +It is documentation repository for the projects of [InsanusMokrassar](https://github.com/InsanusMokrassar). In case you wish to interact with that lib localy, you will need to install dependnecies and mkdocs: + +```bash +pip install mkdocs markdown-callouts mkdocs-autorefs mkdocs-include-dir-to-nav mkdocs-material pymdown-extensions +``` + +**The snippet above can be outdated. See [publish workflow](https://github.com/InsanusMokrassar/docs/blob/master/.github/workflows/publish.yml) to be sure about building steps** + +## Running and build + +In `Fleet` you may use [these configs](https://github.com/InsanusMokrassar/docs/blob/master/.fleet/run.json). Localy there are several common options for build: + +```bash +mkdocs build +``` + +^ Will build mkdocs + +```bash +mkdocs serve +``` + +^ Will continuously build __until first failure in build__