mirror of
https://github.com/dcarrillo/atalaya-docs.git
synced 2026-07-18 23:34:45 +00:00
main
Atalaya docs
Documentation for Atalaya, a self-hosted uptime monitoring tool that runs on Cloudflare Workers.
The published site is at https://atalaya-docs.dcarrillo.es
Built with MkDocs and the Material theme. Deployed to GitHub Pages through the workflow in .github/workflows/deploy.yml on every push to main.
Local development
You need uv and Python 3.x
uv sync
uv run mkdocs serve
That starts a dev server at http://127.0.0.1:8000 with live reload, so edits under docs/ show up as soon as you save.
To build the static site into site/:
uv run mkdocs build
Layout
docs/markdown pages, one file per sectionmkdocs.ymlsite config and navigationoverrides/theme customizations (custom logo icon)docs/stylesheets/extra.csscolor palette overrides
Adding a page means dropping a markdown file in docs/ and listing it under nav in mkdocs.yml.
Description
Languages
SVG
100%