1
0
Fork
You've already forked docs
0
Social Maps Documentation https://docs.socialmaps.org/
  • HTML 92.2%
  • JavaScript 4.9%
  • CSS 2.9%
2026年05月04日 22:17:51 +01:00
.vscode mkdocs added 2025年09月29日 00:51:05 +01:00
api 2026年04月04日: Update OpenAPI spec 2026年04月04日 22:53:42 +01:00
docs Stop using "recommend" 2026年02月08日 13:58:01 +00:00
sdk/android Add "SDK for Android" 2026年05月04日 22:17:51 +01:00
.domains add "socialmaps.codeberg.page" to .domains 2025年09月24日 20:31:09 +01:00
.gitignore Update .gitignore 2026年02月08日 13:58:50 +00:00
.python-version mkdocs added 2025年09月29日 00:51:05 +01:00
index.html add root index.html 2025年09月25日 08:19:33 +01:00
main.py mkdocs added 2025年09月29日 00:51:05 +01:00
Makefile Add "SDK for Android" 2026年05月04日 22:17:51 +01:00
mkdocs.yml Add "SDK for Android" 2026年05月04日 22:17:51 +01:00
pyproject.toml mkdocs added 2025年09月29日 00:51:05 +01:00
README.md improvements 2025年09月29日 22:58:47 +01:00
uv.lock mkdocs added 2025年09月29日 00:51:05 +01:00

Social Maps Documentation

Visit https://docs.socialmaps.org/ for the documentation itself. This README is for contributors.

We use MkDocs and Material for MkDocs to generate a static site for our documentation, and uv as our Python package manager. Our API Reference uses a different software called Scalar, which is a JavaScript application that renders our API Reference client-side based on our OpenAPI spec. The entire documentation is generated statically, which we then host on Codeberg Pages.

Contributing

When you clone the repo for the first time, run

$ git worktree add site/ pages

to checkout the pages branch inside the site/ directory.