diff options
author | Raphael Kabo <raphaelkabo@hey.com> | 2024-02-28 22:39:49 +0000 |
---|---|---|
committer | Raphael Kabo <raphaelkabo@hey.com> | 2024-02-28 22:39:49 +0000 |
commit | d2a3d0272ed7725d0bc848267d560c468235507b (patch) | |
tree | 2605d9b9be3e22abdefd89075b4a8a2187cb9a4a /docs/index.md | |
parent | 35398241dea769bd7554eaca0a9045801c847340 (diff) |
Add docs using MkDocs
Diffstat (limited to 'docs/index.md')
-rw-r--r-- | docs/index.md | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..b42a01f --- /dev/null +++ b/docs/index.md @@ -0,0 +1,16 @@ +# Getting started + +Gathio is a simple, federated, privacy-first event hosting platform. + +You can use the publicly hosted, flagship instance of Gathio at +[https://gath.io](https://gath.io), and you can also run your very own instance +on your own server. + +These docs are here to: + +- Explain the more esoteric or complex features of Gathio +- Help you set up, customize, and run Gathio on your own system + +## Documentation + +The docs are stored in the `docs/` folder in the Git repository and are built with [MkDocs](https://www.mkdocs.org/). |