From 4735bc3f1340a77ee688ef4aaef88ce5282ef4ff Mon Sep 17 00:00:00 2001 From: Jef Roosens Date: Thu, 19 Jun 2025 14:53:40 +0200 Subject: [PATCH 1/2] chore: add docs publish command --- Justfile | 1 + docs/.gitignore | 1 + docs/Justfile | 8 ++++++++ docs/hugo.toml | 2 +- 4 files changed, 11 insertions(+), 1 deletion(-) diff --git a/Justfile b/Justfile index c6cfb67..9320a0e 100644 --- a/Justfile +++ b/Justfile @@ -58,3 +58,4 @@ publish-release-binaries tag: build-release-static --fail \ --upload-file target/aarch64-unknown-linux-musl/release/otter \ https://git.rustybever.be/api/packages/Chewing_Bever/generic/otter/"{{ tag }}"/otter-linux-arm64 + just docs/publish diff --git a/docs/.gitignore b/docs/.gitignore index 9fe8a62..8a38c51 100644 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -2,3 +2,4 @@ public/ *.lock *.tar.gz /resources/_gen/ +auth.txt diff --git a/docs/Justfile b/docs/Justfile index e79463d..2ad4f88 100644 --- a/docs/Justfile +++ b/docs/Justfile @@ -8,5 +8,13 @@ package: build --file ../docs.tar.gz \ * +publish: package + curl \ + -XPOST \ + --fail \ + -H @./auth.txt \ + -T docs.tar.gz \ + https://rustybever.be/docs/otter + serve: hugo serve --buildDrafts diff --git a/docs/hugo.toml b/docs/hugo.toml index d3b38b4..965677d 100644 --- a/docs/hugo.toml +++ b/docs/hugo.toml @@ -1,4 +1,4 @@ -baseURL = 'https://example.org/' +baseURL = 'https://rustybever.be/docs/otter/' languageCode = 'en-us' title = 'Otter' theme = "hugo-book" From 0e91eef0e80f051873c2e28e4a30c2a247d9683a Mon Sep 17 00:00:00 2001 From: Jef Roosens Date: Fri, 20 Jun 2025 10:03:49 +0200 Subject: [PATCH 2/2] docs: write small homepage --- docs/content/_index.md | 33 ++++++++++++++++++++++++++++++++- docs/hugo.toml | 3 +++ 2 files changed, 35 insertions(+), 1 deletion(-) diff --git a/docs/content/_index.md b/docs/content/_index.md index d8e9d74..70434b8 100644 --- a/docs/content/_index.md +++ b/docs/content/_index.md @@ -1 +1,32 @@ -Welcome! +# Otter + +Otter is a standalone implementation of the [Gpodder.net +API](https://gpoddernet.readthedocs.io/en/latest/). Its goal is to be a +lightweight self-hostable alternative to [gpodder.net](https://gpodder.net) for +synchronizing podcast subscriptions and episode states between compatible +clients. + +{{% columns %}} +## Easy to install + +Otter is distributed as a single statically compiled binary, allowing it to be +used in any Linux-based context, be it as a Systemd service or in a Docker +container. + +<---> + +## Simple to configure + +Only a small amount of configuration is required to get Otter up and running, +all of which can be done from a config file, environment variables, or CLI +arguments. + +<---> + +## Multi-user + +Otter supports multiple users and provides functionality for making your server +either public or private, along with easy ways of inviting new users to your +server. Host it for yourself, your friends, or start a public instance! + +{{% /columns %}} diff --git a/docs/hugo.toml b/docs/hugo.toml index 965677d..6b83dfa 100644 --- a/docs/hugo.toml +++ b/docs/hugo.toml @@ -2,3 +2,6 @@ baseURL = 'https://rustybever.be/docs/otter/' languageCode = 'en-us' title = 'Otter' theme = "hugo-book" + +[markup.goldmark.renderer] +unsafe = true