Skip to content

Commit

Permalink
make clearer how to install with requirements
Browse files Browse the repository at this point in the history
also show how plantuml is integrated
  • Loading branch information
pahjbo committed Jun 25, 2024
1 parent c3e029a commit f196cea
Showing 1 changed file with 8 additions and 10 deletions.
18 changes: 8 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,23 @@

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/).
You can find detailed theme instructions in the [mkdodcs material site](https://squidfunk.github.io/mkdocs-material/). However, all of the necessary packages can be installed with

```shell
pip install mkdocs-material
pip install -r requirements.txt
```

## plantuml

Various diagrams are created using plantuml - the markdown plugin for that can be installed with.
Various diagrams are created using [plantuml](https://plantuml.com). The way that this is integrated with markdown is like

```shell
pip install plantuml-markdown
```
```plantuml id="myDiag" format="png" classes="uml myDiagram" alt="My super diagram placeholder" title="My super diagram" width="300px" height="300px"
Goofy -> MickeyMouse: calls
Goofy <-- MickeyMouse: responds
```

## 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 the
[Getting started](https://squidfunk.github.io/mkdocs-material/getting-started/) guide.
## Running the website locally

Once you've made your working copy of the site repo, from the repo root folder, run:

Expand Down

0 comments on commit f196cea

Please sign in to comment.