fix: use new features & remove separate api-docs link page

Author: jmattheis

.vitepress/config.ts

@@ -35,7 +35,7 @@ export default defineConfig({
         },
         {
           text: 'REST-API',
-          items: [{text: 'Swagger Documentation', link: '/docs/swagger-docs'}],
+          items: [{text: 'Swagger Documentation', link: '/api-docs'}],
         },
         {
           text: 'Plugins',

docs/caddy.md

@@ -2,7 +2,7 @@
 
 Setting up [Caddy](https://caddyserver.com) as a reverse proxy is very straightforward. Here are two config examples.
 
-# As a standalone domain
+## As a standalone domain
 
 Here is a sample config file if you run your gotify instance on port 1245
 
@@ -16,7 +16,7 @@ gotify.example.com {
 
 Caddy automatically deploys SSL certificates from Let's Encrypt for your domain. If you want to explicitly disable TLS encryption, prefix your server name with `http://`.
 
-# At a subpath
+## At a subpath
 
 Here is the equivalent of the sample config above but running under a sub path.
 

docs/config.md

@@ -10,12 +10,14 @@ gotify/server looks in the following paths for config files
 - ./config.yml
 - /etc/gotify/config.yml
 
-**Note**: When strings contain reserved yml characters then they need to be escaped.
-[A list of reserved characters and how to escape them.](https://stackoverflow.com/a/22235064/4244993)
-
-**Note**: The config file `/etc/gotify/config.yml` can contain sensitive data
-such as the initial admin password. When using it, you should remove read/write
-rights from users not owning the file:
+> [!note]
+> When strings contain reserved yml characters then they need to be escaped.
+> [A list of reserved characters and how to escape them.](https://stackoverflow.com/a/22235064/4244993)
+
+> [!note]
+> The config file `/etc/gotify/config.yml` can contain sensitive data
+> such as the initial admin password. When using it, you should remove read/write
+> rights from users not owning the file:
 
 ```bash
 $ sudo chmod go-rw /etc/gotify/config.yml

docs/dev-server-and-tests.md

@@ -33,7 +33,7 @@ The UI requires a Gotify server running on `localhost:80`. This can be adjusted
 
 ## Update Swagger spec
 
-The [gotify/server REST-API](swagger-docs.md) is documented via Swagger. The Swagger definition is generated via source code comments
+The [gotify/server REST-API](/api-docs) is documented via Swagger. The Swagger definition is generated via source code comments
 ([example comment](https://github.com/gotify/server/blob/09c1516a170dfb47d29644db622655b540b94922/api/application.go#L33)).
 
 After changing such a source code comment, you can run the following command to update the Swagger definition.

docs/install.md

@@ -26,8 +26,7 @@ The time zone inside the container is configurable via the `TZ` environment vari
 $ docker run -p 80:80 -e TZ="Europe/Berlin" -v /var/gotify/data:/app/data gotify/server
 ```
 
-<details><summary>Docker Compose</summary>
-<p>
+::: details Example docker-compose.yaml
 
 ```yml
 ---
@@ -45,8 +44,7 @@ services:
     # user: "1234:1234"
 ```
 
-</p>
-</details>
+:::details
 
 ## Binary
 

docs/nginx.md

@@ -2,7 +2,7 @@
 
 You may want to use your nginx server as a reverse proxy to run gotify.
 
-# At the root of the domain
+## At the root of the domain
 
 Here is a sample config file if you run your gotify instance on port 1245
 
@@ -45,7 +45,7 @@ server {
 
 If you want to use HTTPS through Nginx, keep the gotify setting GOTIFY_SERVER_SSL_ENABLED=false and rely on nginx to encrypt your traffic like you would with any other website.
 
-# At a subpath
+## At a subpath
 
 Here is the equivalent of the sample config above but running on a subpath
 

docs/plugin-deploy.md

@@ -2,6 +2,7 @@
 
 ## Building
 
+> [!note]
 > This tutorial assumes that you want to build your plugin for gotify/server `v2.0.0`. If you want to build for a different
 > version then replace v2.0.0 with your desired version.
 
@@ -73,6 +74,7 @@ $ docker run --rm -v "$PWD/.:/proj" -w /proj gotify/build:1.12.0-linux-386 \
 
 ### Without Docker (not recommended)
 
+> [!note]
 > Plugins built without the gotify/server build environment, will probably not work with the built binaries from
 > [gotify/server Releases](https://github.com/gotify/server/releases).
 

docs/plugin.md

@@ -1,5 +1,6 @@
 # Intro to Gotify Plugins
 
+> [!warning]
 > Plugins are currently only supported on Linux and MacOS due to a current limitation of golang.
 
 ## Description

docs/swagger-docs.md

@@ -2,10 +2,11 @@
 
 To manage starting, logging, etc. of Gotify, systemd can be used.
 
+> [!note]
 > This is only a minimal example and does not provide the most secure or "best"
 > way to run gotify. Please adjust the config to your needs.
 
-# Installation
+## Installation
 
 For this example, Gotify is installed by root in a directory called
 `/opt/gotify/` and the executable in there is called `gotify`. The config file
@@ -43,7 +44,7 @@ sudo systemctl daemon-reload
 sudo systemctl enable gotify
 ```
 
-# Start
+## Start
 
 Gotify can then be started manually with: