README.md

Helpbuttons Documentation

This is the documentation repository for Helpbuttons — an open-source platform for building geo-based collaborative networks.

Browse the docs: helpbuttons.github.io/hb-docs

---

Contributing to the docs

The docs are written in Markdown and built with MkDocs Material.

Run locally

pip install mkdocs-material mkdocs-render-swagger-plugin mkdocs-git-revision-date-localized-plugin
mkdocs serve

On macOS use pip3 instead of pip.

Open http://localhost:8000.

Structure

docs/
├── English/      # English documentation
├── Castellano/   # Spanish documentation
├── images/       # Images used in the docs
└── index.md      # Landing page

To contribute, edit the Markdown files in docs/ and open a pull request.

---

Part of the Helpbuttons project · help@helpbuttons.org