Skip to content

Commit

Permalink
clean up the README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
pahjbo committed Jun 12, 2024
1 parent 4fd8e11 commit c1f355a
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -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:
Expand Down

0 comments on commit c1f355a

Please sign in to comment.