Skip to content

Commit

Permalink
Update docs info in README.
Browse files Browse the repository at this point in the history
  • Loading branch information
johncollinson2001 committed Oct 7, 2024
1 parent 8697934 commit d4a059b
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,15 +52,15 @@ The repository consists of the following directories:

## Documentation

The documentation is built and served as a static site using dockerised [MkDocs](https://www.mkdocs.org/).
The documentation in markdown format resides in [`./docs`](./docs/index.md). It can also be built and served as a static site using [MkDocs](https://www.mkdocs.org/).

To build and run the docs locally, install Docker then run the following command from the root of the repository:

```pwsh
docker-compose -f ./docs/docker-compose.yml up
```

Once the container is running, navigate to [http://localhost:8000](http://localhost:8000) to access the docs.
Once the container is running, navigate to [http://localhost:8000](http://localhost:8000).

## Contributing

Expand Down

0 comments on commit d4a059b

Please sign in to comment.