Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
-
Install a Python virtual environment (On Linux/macOS):
python3 -m venv venv source venv/bin/activate
-
Install dependencies
pip install -r requirements.txt
-
Build the documentation
mkdocs serve
-
Preview at: http://localhost:8000
-
Install Docker: https://docs.docker.com/get-docker/
-
Open a terminal at this folder to build a Docker-container:
docker build --tag data-service-catalogue .
-
Run the Docker-container:
docker run --rm -it -p 8000:8000 -v ${PWD}:/docs data-service-catalogue
- Material for MkDocs: https://squidfunk.github.io/mkdocs-material/