MINE - Machinestalk Indoor Navigation Engine

Introduction

this is a step-by-step guide documentation made using the material for Mk docs a powerful static site generator geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.

Pre-requisites

• Python 3.8 or higher
• Github cli or git
• Code editor (Webstorm, VS Code, Sublime Text, etc)

Installation

• Using pip:

pip install mkdocs-material

This will automatically install compatible versions of all dependencies: MkDocs, Markdown, Pygments and Python Markdown Extensions.

• Using docker:

docker pull squidfunk/mkdocs-material

• Using git:

git clone https://github.com/squidfunk/mkdocs-material.git
cd mkdocs-material
pip install -e .

Usage

MkDocs material is built on top of MkDocs, which is uses python markdown to convert markdown files to html.

inside the project directory, run the following command:

python -m venv env

then activate the virtual environment:

source env/bin/activate

then run the server:

mkdocs serve

Congratulations! you have successfully run the server, now you can access the documentation

Deployment

this project contains a github action that will automatically deploy the documentation to github pages when a new commit is pushed to the main branch. you can find the github action file in the .github/workflows directory.

⭐️ Support Us by Starring the Repository!

If you find this project helpful or interesting, please consider giving it a ⭐️. It really helps us out by:

• Increasing visibility and letting more people know about the project.
• Encouraging continued development and improvements.
• Showing your support and appreciation for the work put into the project.

Happy coding!