aboutsummaryrefslogtreecommitdiffstats
path: root/docs/docusaurus.config.ts
diff options
context:
space:
mode:
authorMohamed Bassem <me@mbassem.com>2025-12-13 11:05:05 +0000
committerMohamed Bassem <me@mbassem.com>2025-12-13 11:05:05 +0000
commitaf69f637cc474325d9d8a6b468816778b08e600d (patch)
treec8b10e12e854aecf65db2ddf146d32027287b0d3 /docs/docusaurus.config.ts
parentb43444018ec99d33937ba66b320f62bc34d7c571 (diff)
downloadkarakeep-af69f637cc474325d9d8a6b468816778b08e600d.tar.zst
docs: restructure the docs
Diffstat (limited to 'docs/docusaurus.config.ts')
-rw-r--r--docs/docusaurus.config.ts87
1 files changed, 83 insertions, 4 deletions
diff --git a/docs/docusaurus.config.ts b/docs/docusaurus.config.ts
index 9de88d45..1ba393d1 100644
--- a/docs/docusaurus.config.ts
+++ b/docs/docusaurus.config.ts
@@ -19,7 +19,7 @@ const config: Config = {
organizationName: "karakeep-app", // Usually your GitHub org/user name.
projectName: "karakeep", // Usually your repo name.
- onBrokenLinks: "throw",
+ onBrokenLinks: "warn",
onBrokenMarkdownLinks: "warn",
// Even if you don't use internationalization, you can use this field to set
@@ -58,6 +58,85 @@ const config: Config = {
],
plugins: [
[
+ "@docusaurus/plugin-client-redirects",
+ {
+ // redirects: [
+ // {
+ // to: "/getting-started/intro",
+ // from: "/intro",
+ // },
+ // {
+ // to: "/getting-started/screenshots",
+ // from: "/screenshots",
+ // },
+ // {
+ // to: "/configuration/environment-variables",
+ // from: "/configuration",
+ // },
+ // {
+ // to: "/using-karakeep/quick-sharing",
+ // from: "/quick-sharing",
+ // },
+ // {
+ // to: "/using-karakeep/import",
+ // from: "/import",
+ // },
+ // {
+ // to: "/using-karakeep/search-query-language",
+ // from: "/guides/search-query-language",
+ // },
+ // {
+ // to: "/integrations/openai",
+ // from: "/openai",
+ // },
+ // {
+ // to: "/integrations/command-line",
+ // from: "/command-line",
+ // },
+ // {
+ // to: "/integrations/mcp",
+ // from: "/mcp",
+ // },
+ // {
+ // to: "/integrations/different-ai-providers",
+ // from: "/guides/different-ai-providers",
+ // },
+ // {
+ // to: "/integrations/singlefile",
+ // from: "/guides/singlefile",
+ // },
+ // {
+ // to: "/administration/security-considerations",
+ // from: "/security-considerations",
+ // },
+ // {
+ // to: "/administration/FAQ",
+ // from: "/FAQ",
+ // },
+ // {
+ // to: "/administration/troubleshooting",
+ // from: "/troubleshooting",
+ // },
+ // {
+ // to: "/administration/server-migration",
+ // from: "/guides/server-migration",
+ // },
+ // {
+ // to: "/administration/legacy-container-upgrade",
+ // from: "/guides/legacy-container-upgrade",
+ // },
+ // {
+ // to: "/administration/hoarder-to-karakeep-migration",
+ // from: "/guides/hoarder-to-karakeep-migration",
+ // },
+ // {
+ // to: "/community/community-projects",
+ // from: "/community-projects",
+ // },
+ // ],
+ },
+ ],
+ [
"docusaurus-plugin-openapi-docs",
{
id: "api",
@@ -110,10 +189,10 @@ const config: Config = {
},
algolia: {
- appId: 'V93C1M14G6',
+ appId: "V93C1M14G6",
// Public API key: it is safe to commit it
- apiKey: '0eb8853d9740822fb9d21620d5515f35',
- indexName: 'karakeep',
+ apiKey: "0eb8853d9740822fb9d21620d5515f35",
+ indexName: "karakeep",
contextualSearch: true,
insights: true,
},