opendata.scot_docs

Documentation for the opendata.scot project. Hosted on docs.opendata.scot.

Getting started

Prerequisites

To get started with this project, you should have the following installed:

• Python 3.x
• Python Package Manager (Pip)

Running the project

You first need to install the required packages for MkDocs with the following command in your terminal:

pip install mkdocs mkdocs-mermaid2-plugin

Then, from the root of the directory, you can run the documentation site by running the following command:

mkdocs serve

or

python -m mkdocs serve

Once the site builds, you can access it in a browser at http://127.0.0.1:8000.