website: Flesh out docs split.

website: Copy files during build. website: Allow for mixed env builds. website: Reduce build size. website: Expose build. website: Add build memory debugging. WIP: Disable broken links check to compare memory usage. website: Update deps. website: Clean up API paths. website: Flesh out 3.8 fixes. Format. website: Update ignore paths. Website: Clean up integrations build. website: Fix paths. website: Optimize remark. website: Update deps. website: Format. website: Remove linking. website: Fix paths. wip: Attempt API only build. Prep. Migrate render to runtime. Tidy sidebar. Clean up templates. docs: Move directory. WIP docs: Flesh out split. website: Fix issue where routes have collisions.
2025-06-17 21:02:38 +02:00
parent b10c795a26
commit 582812b3ec
704 changed files with 5179 additions and 4670 deletions
--- a/docs/topics/docusaurus.config.esm.mjs
+++ b/docs/topics/docusaurus.config.esm.mjs
@ -0,0 +1,92 @@
+/**
+ * @file Docusaurus Documentation config.
+ *
+ * @import { Config } from "@docusaurus/types";
+ * @import { UserThemeConfig, UserThemeConfigExtra } from "@goauthentik/docusaurus-config";
+ * @import { Options as DocsPluginOptions } from "@docusaurus/plugin-content-docs";
+ * @import { ReleasesPluginOptions } from "@goauthentik/docusaurus-theme/releases/plugin"
+ */
+import { createDocusaurusConfig } from "@goauthentik/docusaurus-config";
+import { CommonConfig, CommonDocsPluginOptions } from "@goauthentik/docusaurus-theme/config";
+import { remarkLinkRewrite } from "@goauthentik/docusaurus-theme/remark";
+
+import { GlobExcludeDefault } from "@docusaurus/utils";
+import { deepmerge } from "deepmerge-ts";
+import { createRequire } from "node:module";
+import { resolve } from "node:path";
+import { fileURLToPath } from "node:url";
+
+const __dirname = fileURLToPath(new URL(".", import.meta.url));
+const require = createRequire(import.meta.url);
+
+/**
+ * Documentation site configuration for Docusaurus.
+ * @satisfies {Partial<Config>}
+ */
+const config = {
+    staticDirectories: [
+        // ---
+        resolve(__dirname, "..", "static"),
+        "static",
+    ],
+
+    themes: ["@goauthentik/docusaurus-theme"],
+
+    themeConfig: /** @type {UserThemeConfig & UserThemeConfigExtra} */ ({
+        navbarReplacements: {
+            DOCS_URL: "/",
+        },
+        algolia: {
+            externalUrlRegex: /^(?:https?:\/\/)(integrations|api).?(goauthentik.io)/.source,
+        },
+    }),
+
+    plugins: [
+        [
+            "@docusaurus/theme-classic",
+            {
+                customCss: require.resolve("@goauthentik/docusaurus-config/css/index.css"),
+            },
+        ],
+
+        [
+            "@goauthentik/docusaurus-theme/releases/plugin",
+            /** @type {ReleasesPluginOptions} */ ({
+                docsDirectory: __dirname,
+            }),
+        ],
+
+        //#region Documentation
+
+        [
+            "@docusaurus/plugin-content-docs",
+            deepmerge(
+                CommonDocsPluginOptions,
+                /** @type {DocsPluginOptions} */ ({
+                    id: "docs",
+                    routeBasePath: "/",
+                    path: ".",
+                    exclude: [...GlobExcludeDefault],
+                    include: ["**/*.mdx", "**/*.md"],
+
+                    sidebarPath: "./sidebar.mjs",
+                    showLastUpdateTime: false,
+                    editUrl: "https://github.com/goauthentik/authentik/edit/main/docs/",
+
+                    //#region Docs Plugins
+
+                    beforeDefaultRemarkPlugins: [
+                        remarkLinkRewrite([
+                            // ---
+                            ["/docs", ""],
+                            ["/api", "https://api.goauthentik.io"],
+                            ["/integrations", "https://integrations.goauthentik.io"],
+                        ]),
+                    ],
+                }),
+            ),
+        ],
+    ],
+};
+
+export default /** @type {Config} */ (deepmerge(CommonConfig, createDocusaurusConfig(config)));