diff options
| author | Mohamed Bassem <me@mbassem.com> | 2024-10-20 18:13:48 +0000 |
|---|---|---|
| committer | Mohamed Bassem <me@mbassem.com> | 2024-10-20 18:13:48 +0000 |
| commit | 6ffa51dfcc5d2a0e997841e547f4a50bbd9dbb3b (patch) | |
| tree | dd64f6d15d3ad29acd5d1d2a4e0795797bde2741 /docs/docusaurus.config.ts | |
| parent | 3c1ec3aa2f7d64932fd26c8cbcb1aee1e57861bd (diff) | |
| download | karakeep-6ffa51dfcc5d2a0e997841e547f4a50bbd9dbb3b.tar.zst | |
docs: Generate OpenAPI docs
Diffstat (limited to 'docs/docusaurus.config.ts')
| -rw-r--r-- | docs/docusaurus.config.ts | 20 |
1 files changed, 15 insertions, 5 deletions
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, ], ], @@ -63,6 +68,11 @@ const config: Config = { position: 'right', }, { + to: '/api', + label: 'API', + position: 'right', + }, + { href: 'https://hoarder.app', label: 'Homepage', position: 'right', |
