https://github.com/kvrae/mine-docs
Mine docs for the indoor library
https://github.com/kvrae/mine-docs
android documentation markdown mkdocs-material module
Last synced: 3 months ago
JSON representation
Mine docs for the indoor library
- Host: GitHub
- URL: https://github.com/kvrae/mine-docs
- Owner: KvRae
- License: gpl-3.0
- Created: 2024-02-24T14:49:32.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-26T19:29:08.000Z (11 months ago)
- Last Synced: 2024-07-26T20:22:49.404Z (11 months ago)
- Topics: android, documentation, markdown, mkdocs-material, module
- Homepage: https://kvrae.me/MINE-Docs/
- Size: 2.71 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Support: docs/support/contact_us.md
Awesome Lists containing this project
README
# MINE - Machinestalk Indoor Navigation Engine
[](https://github.com/KvRae/MachInNav-Engine-Docs/actions/workflows/ci.yml)
[](https://www.python.org/downloads/)
[](https://www.mkdocs.org/)
[](https://squidfunk.github.io/mkdocs-material/)
## 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:
```bash
pip install mkdocs-material
```
This will automatically install compatible versions of all dependencies: MkDocs, Markdown, Pygments and Python Markdown Extensions.
- Using docker:
```bash
docker pull squidfunk/mkdocs-material
```
- Using git:
```bash
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:
```bash
python -m venv env
```
then activate the virtual environment:
```bash
source env/bin/activate
```
then run the server:
```bash
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!