README.md

Propeller Documentation

This repo collects the collaborative work on Propeller documentation.

Documentation is auto-generated from Markdown files in this repo.

MkDocs is used to serve the docs locally with different theming.

Install

Doc repo can be fetched from GitHub:

git clone https://github.com/absmach/propeller-docs.git

Prerequisites

Python 3.7 or higher is required to run MkDocs.

1. Create a virtual environment:

   python -m venv venv

2. Activate the virtual environment:

   source venv/bin/activate

3. Install MkDocs

   pip install mkdocs

4. Additionally, install Material theme:

   pip install mkdocs-material

Usage

Use MkDocs to serve documentation:

mkdocs serve

Then just point the browser to http://127.0.0.1:8000.