From 6ffa51dfcc5d2a0e997841e547f4a50bbd9dbb3b Mon Sep 17 00:00:00 2001
From: Mohamed Bassem <me@mbassem.com>
Date: Sun, 20 Oct 2024 18:13:48 +0000
Subject: docs: Generate OpenAPI docs

---
 docs/docusaurus.config.ts | 20 +++++++++++++++-----
 1 file changed, 15 insertions(+), 5 deletions(-)

(limited to 'docs/docusaurus.config.ts')

diff --git a/docs/docusaurus.config.ts b/docs/docusaurus.config.ts
index 54e6ae05..ebc39a9c 100644
--- a/docs/docusaurus.config.ts
+++ b/docs/docusaurus.config.ts
@@ -1,6 +1,7 @@
 import {themes as prismThemes} from 'prism-react-renderer';
 import type {Config} from '@docusaurus/types';
 import type * as Preset from '@docusaurus/preset-classic';
+import type * as OpenApiPlugin from "docusaurus-preset-openapi";
 
 const config: Config = {
   title: 'Hoarder Docs',
@@ -15,8 +16,8 @@ const config: Config = {
 
   // GitHub pages deployment config.
   // If you aren't using GitHub pages, you don't need these.
-  organizationName: 'MohamedBassem', // Usually your GitHub org/user name.
-  projectName: 'hoarder-app', // Usually your repo name.
+  organizationName: 'hoarder-app', // Usually your GitHub org/user name.
+  projectName: 'hoarder', // Usually your repo name.
 
   onBrokenLinks: 'throw',
   onBrokenMarkdownLinks: 'warn',
@@ -31,19 +32,23 @@ const config: Config = {
 
   presets: [
     [
-      'classic',
-      {
+      'docusaurus-preset-openapi',
+      ({
         docs: {
           sidebarPath: './sidebars.ts',
           editUrl:
             'https://github.com/hoarder-app/hoarder/tree/main/docs/',
           routeBasePath: "/",
         },
+        api: {
+          path: "../packages/open-api/hoarder-openapi-spec.json",
+          routeBasePath: '/api',
+        },
         blog: false,
         theme: {
           customCss: './src/css/custom.css',
         },
-      } satisfies Preset.Options,
+      }) satisfies OpenApiPlugin.Options,
     ],
   ],
 
@@ -62,6 +67,11 @@ const config: Config = {
           type: 'docsVersionDropdown',
           position: 'right',
         },
+        {
+          to: '/api',
+          label: 'API',
+          position: 'right',
+        },
         {
           href: 'https://hoarder.app',
           label: 'Homepage',
-- 
cgit v1.2.3-70-g09d2