diff --git a/README.md b/README.md index 2b1e2f0..a07c1d9 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,25 @@ # Polaris Documentation - This **Polaris proposal tool documentation** uses the mkdocs material theme + This **Polaris proposal tool documentation** uses the mkdocs material theme which in turn requires python to be installed. You can find detailed theme instructions in the [mkdodcs material site](https://squidfunk.github.io/mkdocs-material/). +```shell +pip install mkdocs-material +``` + ## plantuml +Various diagrams are created using plantuml - the markdown plugin for that can be installed with. + ```shell pip install plantuml-markdown ``` -https://github.com/neurobin/mdx_include - proper extension structure -> https://github.com/mikitex70/plantuml-markdown need that doing... https://python-markdown.github.io/extensions/api/ - ## Running the website locally Building and running the site locally requires python with the `mkdocs-material` package installed. -You can find out more about how to install mkdocs material for your environment in our +You can find out more about how to install mkdocs material for your environment in the [Getting started](https://squidfunk.github.io/mkdocs-material/getting-started/) guide. Once you've made your working copy of the site repo, from the repo root folder, run: