docs: initialise new docs with docusaurus (#460)

* docs: initialise new docs with docusaurus * chore: sign off Signed-off-by: izzy <me@insrt.uk> * chore: lock pnpm version in package.json Signed-off-by: izzy <me@insrt.uk> * ci: specify package json to load pnpm version from Signed-off-by: izzy <me@insrt.uk> * docs: update repo. lifecycle details Signed-off-by: izzy <me@insrt.uk> * docs: add external links to for-web, for-android chore: add default.nix to docs * docs: correct headings in contrib * ci: use cache dependency path * fix: docusaurus configuration --------- Signed-off-by: izzy <me@insrt.uk>
2026-07-14 05:26:59 +00:00 · 2025-11-14 22:06:20 +00:00
parent e006cdd051
commit 0b7c132ace
38 changed files with 31136 additions and 57 deletions
--- a/docs/docusaurus.config.ts
+++ b/docs/docusaurus.config.ts
@@ -0,0 +1,182 @@
+import { themes as prismThemes } from 'prism-react-renderer';
+import type { Config } from '@docusaurus/types';
+import type * as Preset from '@docusaurus/preset-classic';
+import type { ScalarOptions } from '@scalar/docusaurus';
+
+const config: Config = {
+  title: 'Stoat Developers',
+  tagline: 'Developer documentation for Stoat',
+  favicon: 'https://stoat.chat/favicon.svg',
+
+  future: {
+    v4: true,
+  },
+
+  url: 'https://developers.stoat.chat',
+  baseUrl: '/',
+
+  organizationName: 'stoatchat',
+  projectName: 'stoatchat',
+
+  onBrokenLinks: 'throw',
+
+  i18n: {
+    defaultLocale: 'en',
+    locales: ['en'],
+  },
+
+  presets: [
+    [
+      'classic',
+      {
+        docs: {
+          routeBasePath: '/',
+          sidebarPath: './sidebars.ts',
+          editUrl:
+            'https://github.com/stoatchat/stoatchat/tree/main/docs/',
+        },
+      } satisfies Preset.Options,
+    ],
+  ],
+
+  plugins: [
+    [
+      '@scalar/docusaurus',
+      {
+        label: 'API Reference',
+        route: '/api-reference',
+        showNavLink: true,
+        configuration: {
+          url: 'https://stoat.chat/api/openapi.json',
+        },
+      } as ScalarOptions,
+    ],
+    [
+      '@docusaurus/plugin-client-redirects',
+      {
+        fromExtensions: ['html', 'htm'],
+        redirects: [
+          // legacy docs website (stoatchat/developer-wiki)
+          {
+            from: '/developers/api/reference.html',
+            to: '/api-reference',
+          },
+          {
+            from: '/contrib.html',
+            to: '/developing/contrib',
+          },
+          {
+            from: '/contrib',
+            to: '/developing/contrib',
+          },
+        ],
+      }
+    ],
+  ],
+
+  themeConfig: {
+    // image: 'img/docusaurus-social-card.jpg',
+    colorMode: {
+      respectPrefersColorScheme: true,
+    },
+    navbar: {
+      title: 'Stoat Developers',
+      logo: {
+        alt: 'Stoat',
+        src: 'https://stoat.chat/favicon.svg',
+      },
+      items: [
+        {
+          type: 'doc',
+          docId: 'index',
+          label: 'Docs'
+        },
+        {
+          href: 'https://github.com/stoatchat',
+          label: 'GitHub',
+          position: 'right',
+        },
+      ],
+    },
+    footer: {
+      style: 'dark',
+      links: [
+        {
+          title: 'Developers',
+          items: [
+            {
+              label: 'Source Code',
+              href: 'https://github.com/stoatchat'
+            },
+            {
+              label: 'Help Translate',
+              href: 'https://translate.stoat.chat'
+            },
+          ],
+        },
+        {
+          title: 'Team',
+          items: [
+            {
+              label: 'About',
+              href: 'https://stoat.chat/about'
+            },
+            {
+              label: 'Blog and Changelogs',
+              href: 'https://stoat.chat/updates'
+            },
+            {
+              label: 'Contact',
+              href: 'https://support.stoat.chat'
+            },
+          ],
+        },
+        {
+          title: 'Stoat on Socials',
+          items: [
+            {
+              label: 'Bluesky',
+              href: 'https://bsky.app/profile/stoat.chat'
+            },
+            {
+              label: 'Reddit',
+              href: 'https://reddit.com/r/stoatchat'
+            },
+            {
+              label: 'Stoat Server',
+              href: 'https://stt.gg/Testers'
+            },
+          ],
+        },
+        {
+          title: 'Legal',
+          items: [
+            {
+              label: 'Community Guidelines',
+              href: 'https://stoat.chat/legal/community-guidelines'
+            },
+            {
+              label: 'Terms of Service',
+              href: 'https://stoat.chat/legal/terms'
+            },
+            {
+              label: 'Privacy Policy',
+              href: 'https://stoat.chat/legal/privacy'
+            },
+            {
+              label: 'Imprint',
+              href: 'https://stoat.chat/legal/imprint'
+            },
+          ],
+        },
+      ],
+      copyright: `© Revolt Platforms Ltd, ${new Date().getFullYear()}`,
+    },
+    prism: {
+      theme: prismThemes.github,
+      darkTheme: prismThemes.dracula,
+    },
+  } satisfies Preset.ThemeConfig,
+};
+
+export default config;