https://github.com/infrasonar/docs
Infra Sonar documentation
https://github.com/infrasonar/docs
documentation infrasonar mkdocs
Last synced: 5 months ago
JSON representation
Infra Sonar documentation
- Host: GitHub
- URL: https://github.com/infrasonar/docs
- Owner: infrasonar
- Created: 2022-10-17T12:59:27.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-12-17T08:46:25.000Z (6 months ago)
- Last Synced: 2025-12-20T21:54:13.085Z (6 months ago)
- Topics: documentation, infrasonar, mkdocs
- Language: HTML
- Homepage:
- Size: 61.6 MB
- Stars: 1
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Support: docs/support/consultancy.md
Awesome Lists containing this project
README
# InfraSonar documentation
This is the repository for the InfraSonar documentation. It makes use of [MkDocs](https://www.mkdocs.org/) and the [Material](https://squidfunk.github.io/mkdocs-material/) theme.
---
## Installation
### Local
Installing the required pip packages:
```bash
pip install -r requirements.txt
```
Start the server:
```bash
mkdocs serve
```
### Docker
The following commands build the site and start the server on http://127.0.0.1:8000
Observe we overwrite the path with our local path, this allows for live updates while making modifications to the site.
```bash
docker build -t infrasonardocs .
docker run --rm --volume="$PWD:/usr/src/app" -p 8000:8000 infrasonardocs
```
## Editing
* [Find supported emojis](https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/)
## Deploying
Building should be done by creating a new version tag. This will trigger a gh-action which executes `mkdocs gh-deploy`.
```bash
git tag v0.1.0
git push origin v0.1.0
```