{"id":16159083,"url":"https://github.com/kvrae/mine-docs","last_synced_at":"2025-10-09T22:33:45.906Z","repository":{"id":224215552,"uuid":"762735252","full_name":"KvRae/MINE-Docs","owner":"KvRae","description":"Mine docs for the indoor library ","archived":false,"fork":false,"pushed_at":"2024-12-17T12:39:49.000Z","size":4130,"stargazers_count":6,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-09T22:33:23.451Z","etag":null,"topics":["android","documentation","markdown","mkdocs-material","module"],"latest_commit_sha":null,"homepage":"https://kvrae.github.io/MINE-Docs/","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/KvRae.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":"docs/support/contact_us.md","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-02-24T14:49:32.000Z","updated_at":"2025-09-08T09:21:39.000Z","dependencies_parsed_at":"2024-04-15T11:51:19.457Z","dependency_job_id":"6ccfef27-523a-462b-8938-97801284bf34","html_url":"https://github.com/KvRae/MINE-Docs","commit_stats":null,"previous_names":["kvrae/docs-generation","kvrae/machinnav-engine-docs","kvrae/mine-docs"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/KvRae/MINE-Docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KvRae%2FMINE-Docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KvRae%2FMINE-Docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KvRae%2FMINE-Docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KvRae%2FMINE-Docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/KvRae","download_url":"https://codeload.github.com/KvRae/MINE-Docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KvRae%2FMINE-Docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279002107,"owners_count":26083307,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-09T02:00:07.460Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["android","documentation","markdown","mkdocs-material","module"],"created_at":"2024-10-10T01:56:34.039Z","updated_at":"2025-10-09T22:33:45.888Z","avatar_url":"https://github.com/KvRae.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"![Full Logo](https://github.com/KvRae/MachInNav-Engine-Docs/assets/58667227/0c18324c-3cbd-4453-a7a3-84948052b778)\n\n# MINE - Machinestalk Indoor Navigation Engine\n\n[![Deployment](https://github.com/KvRae/MachInNav-Engine-Docs/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/KvRae/MachInNav-Engine-Docs/actions/workflows/ci.yml)\n[![Python Version](https://img.shields.io/badge/python-3.8%20%7C%203.9-blue)](https://www.python.org/downloads/)\n[![MkDocs Version](https://img.shields.io/badge/mkdocs-1.2.2-blue)](https://www.mkdocs.org/)\n[![Material Version](https://img.shields.io/badge/material-7.0.0-blue)](https://squidfunk.github.io/mkdocs-material/)\n## Introduction\nthis is a step-by-step guide documentation made using the material for Mk docs a powerful static site generator geared towards building project documentation.\nDocumentation source files are written in Markdown, and configured with a single YAML configuration file.\n\n## Pre-requisites\n- Python 3.8 or higher\n- Github cli or git\n- Code editor (Webstorm, VS Code, Sublime Text, etc)\n\n## Installation\n- Using pip:\n```bash\npip install mkdocs-material\n```\nThis will automatically install compatible versions of all dependencies: MkDocs, Markdown, Pygments and Python Markdown Extensions.\n\n- Using docker:\n```bash\ndocker pull squidfunk/mkdocs-material\n```\n\n- Using git:\n```bash\ngit clone https://github.com/squidfunk/mkdocs-material.git\ncd mkdocs-material\npip install -e .\n```\n\n## Usage\nMkDocs material is built on top of MkDocs, which is uses python markdown to convert markdown files to html.\n\ninside the project directory, run the following command:\n```bash\npython -m venv env\n```\n\nthen activate the virtual environment:\n```bash\nsource env/bin/activate\n```\n\nthen run the server:\n```bash\nmkdocs serve\n```\n\nCongratulations! you have successfully run the server, now you can access the documentation\n\n## Deployment\nthis project contains a github action that will automatically deploy the documentation to github pages when a new commit is pushed to the main branch.\nyou can find the github action file in the .github/workflows directory.\n\n## ⭐️ Support Us by Starring the Repository!\n\nIf you find this project helpful or interesting, please consider giving it a ⭐️. It really helps us out by:\n\n- Increasing visibility and letting more people know about the project.\n- Encouraging continued development and improvements.\n- Showing your support and appreciation for the work put into the project.\n\nHappy coding!\n\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkvrae%2Fmine-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkvrae%2Fmine-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkvrae%2Fmine-docs/lists"}