refactor: 📝 Move documentation to a custom VitePress site

2026-04-28 13:19:16 +02:00 · 2024-11-10 15:24:34 +01:00 · 2024-11-10 15:24:34 +01:00 · 06a8dd1c0a
commit 06a8dd1c0a
parent 19d8680289
26 changed files with 1449 additions and 775 deletions
--- a/docs/.vitepress/config.ts
+++ b/docs/.vitepress/config.ts
@ -0,0 +1,105 @@
+import taskLists from "@hackmd/markdown-it-task-lists";
+import implicitFigures from "markdown-it-image-figures";
+import { defineConfig } from "vitepress";
+import { tabsMarkdownPlugin } from "vitepress-plugin-tabs";
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+    title: "Versia Server Docs",
+    lang: "en-US",
+    description: "Documentation for Versia Server APIs",
+    markdown: {
+        config: (md): void => {
+            md.use(implicitFigures, {
+                figcaption: "alt",
+                copyAttrs: "^class$",
+            });
+
+            md.use(taskLists);
+
+            md.use(tabsMarkdownPlugin);
+        },
+        math: true,
+    },
+    themeConfig: {
+        // https://vitepress.dev/reference/default-theme-config
+        nav: [
+            { text: "Home", link: "/" },
+            {
+                text: "Versia Protocol",
+                link: "https://versia.pub",
+                target: "_blank",
+            },
+        ],
+
+        sidebar: [
+            {
+                text: "Setup",
+                items: [
+                    {
+                        text: "Installation",
+                        link: "/setup/installation",
+                    },
+                    {
+                        text: "Database",
+                        link: "/setup/database",
+                    },
+                ],
+            },
+            {
+                text: "CLI",
+                link: "/cli",
+            },
+            {
+                text: "API",
+                items: [
+                    {
+                        text: "Emojis",
+                        link: "/api/emojis",
+                    },
+                    {
+                        text: "Roles",
+                        link: "/api/roles",
+                    },
+                    {
+                        text: "Challenges",
+                        link: "/api/challenges",
+                    },
+                    {
+                        text: "SSO",
+                        link: "/api/sso",
+                    },
+                    {
+                        text: "Mastodon Extensions",
+                        link: "/api/mastodon",
+                    },
+                ],
+            },
+            {
+                text: "Frontend",
+                items: [
+                    {
+                        text: "Authentication",
+                        link: "/frontend/auth",
+                    },
+                    {
+                        text: "Routes",
+                        link: "/frontend/routes",
+                    },
+                ],
+            },
+        ],
+
+        socialLinks: [
+            { icon: "github", link: "https://github.com/versia-pub/server" },
+        ],
+
+        search: {
+            provider: "local",
+        },
+
+        logo: "https://cdn.versia.pub/branding/icon.svg",
+    },
+    head: [["link", { rel: "icon", href: "/favicon.png", type: "image/png" }]],
+    titleTemplate: ":title • Versia Server Docs",
+});