Building this Documentation

1. Get the Sources

In a directory of your choice (assumes git is installed):

$ git clone https://github.com/julianeisel/devdocs.git
$ cd devdocs

2. Install Dependencies

Install Material for MkDocs and all the necessary extensions/plugins:

sudo python -m pip install -r requirements.txt

You may have to use python3 instead of python.

3. Build

Option 1: Build and Live Reload

While working on the documentation, it is useful to use the live reloading feature from MkDocs:

mkdocs serve

This will print a URL under which you will find the latest build of your documentation that is updated continuously while working on it.

Option 2: Build only

To only build the documentation without serving it:

mkdocs build

This will print a folder containing the index.html to open in a web browser.

---

Last update: 2023-06-12
Created: 2023-06-12