Skip to content

Access Lab Description with MkDocs⚓︎

The lab description is written with MkDocs.

  • mkdocs serve - Start the live-reloading docs server.
  • mkdocs build - Build the documentation site.
  • mkdocs -h - Print help message and exit.

Install MkDocs⚓︎

See MkDocs Installation Guide.

Prepare Installation on Ubuntu⚓︎

Install Python⚓︎

sudo apt-get install python3

Install Pip⚓︎

sudo apt-get install pip

Check the installation:

pip -V

Prepare Installation on Windows⚓︎

Install Python and Pip⚓︎

Use the windows installer available here.

Check the installation:

pip -V

Install MkDocs⚓︎

pip install mkdocs
pip install mkdocs-material
pip install mkdocs-material-extensions

Publish Lab Description Locally with MkDocs⚓︎

  1. mkdocs build
  2. mkddocs serve
  3. Open in browser