@goauthentik/docusaurus-config 1.1.0 → 2.1.2

package/css/root.css

@@ -9,7 +9,7 @@
     --ifm-color-primary-lighter: #fd7159;
     --ifm-color-primary-lightest: #fe9786;
 
-    --ifm-hover-overlay: hsl(0deg 0% 100% / 25%);
+    --ifm-color-primary-inverse: var(--white);
 
-    --ifm-color-content: hsl(216 35% 3%);
+    --ifm-hover-overlay: hsl(0deg 0% 100% / 25%);
 }

package/index.js

@@ -4,3 +4,5 @@
 
 export * from "./lib/theme.js";
 export * from "./lib/common.js";
+export * from "./lib/routing.js";
+export * from "./lib/navbar.js";

package/lib/common.js

@@ -1,8 +1,8 @@
 /**
  * @file Common Docusaurus configuration utilities.
  *
- * @import { Config as DocusaurusConfig } from "@docusaurus/types"
- * @import { UserThemeConfig } from "./theme.js"
+ * @import { Config, DocusaurusConfig } from "@docusaurus/types"
+ * @import { UserThemeConfig, UserThemeConfigExtra } from "./theme.js"
  */
 import { deepmerge } from "deepmerge-ts";
 
@@ -11,14 +11,14 @@ import { createThemeConfig } from "./theme.js";
 //#region Types
 
 /**
- * @typedef {Omit<DocusaurusConfig, 'themeConfig'>} DocusaurusConfigBase
+ * @typedef {Omit<Config, 'themeConfig'>} DocusaurusConfigBase
  *
  * Represents the base configuration for Docusaurus, excluding the theme configuration.
  */
 
 /**
  * @typedef DocusaurusConfigBaseTheme
- * @property {UserThemeConfig} themeConfig The theme configuration.
+ * @property {UserThemeConfig & UserThemeConfigExtra} themeConfig The theme configuration.
  *
  * Represents a configuration object, only including the theme configuration.
  */
@@ -39,31 +39,66 @@ import { createThemeConfig } from "./theme.js";
 //#region Functions
 
 /**
- * Create a Docusaurus configuration.
- *
- * @param {DocusaurusConfigInit} [overrides] The options to override.
- * @returns {DocusaurusConfig}
+ * Create a default Docusaurus configuration.
  */
-export function createDocusaurusConfig({ themeConfig, ...overrides } = {}) {
+export function createDefaultDocusaurusConfig() {
+    const NodeEnvironment = process.env.AK_DOCUSAURUS_ENV || process.env.NODE_ENV || "development";
+    const production = NodeEnvironment === "production";
+
     /**
-     * @type {DocusaurusConfig}
+     * @satisfies {Config}
      */
-    const config = {
+    const DEFAULT_CONFIG = /** @type {const} */ ({
+        trailingSlash: true,
+        future: {
+            v4: {
+                removeLegacyPostBuildHeadAttribute: true,
+                useCssCascadeLayers: false,
+            },
+            experimental_faster: {
+                swcJsLoader: true,
+                rspackBundler: true,
+                lightningCssMinimizer: production,
+                swcJsMinimizer: production,
+                swcHtmlMinimizer: production,
+                ssgWorkerThreads: production,
+                mdxCrossCompilerCache: production,
+                rspackPersistentCache: production,
+            },
+        },
         title: "authentik",
         tagline: "Bring all of your authentication into a unified platform.",
         url: "https://docs.goauthentik.io",
         baseUrl: "/",
         onBrokenLinks: "throw",
         onBrokenAnchors: "throw",
+        onBrokenMarkdownLinks: "throw",
+        onDuplicateRoutes: "throw",
         favicon: "img/icon.png",
         organizationName: "Authentik Security Inc.",
         projectName: "authentik",
         markdown: {
             mermaid: true,
         },
+    });
+
+    return DEFAULT_CONFIG;
+}
+
+/**
+ * Create a Docusaurus configuration.
+ *
+ * @template {Partial<Config>} T
+ * @param {T} overrides The options to override.
+ * @returns {T & ReturnType<typeof createDefaultDocusaurusConfig>}
+ */
+export function createDocusaurusConfig({ themeConfig, ...overrides }) {
+    const config = {
+        ...createDefaultDocusaurusConfig(),
         themeConfig: createThemeConfig(themeConfig),
     };
 
+    // @ts-ignore
     return deepmerge(config, overrides);
 }
 

package/lib/navbar.js

@@ -0,0 +1,110 @@
+/**
+ * @file Docusaurus navbar configuration for the authentik website.
+ *
+ * @import { NavbarItem } from "@docusaurus/theme-common";
+ */
+import { DocusaurusURL, SocialURL } from "./routing.js";
+
+/**
+ * The navbar items for the authentik website.
+ *
+ * @type {NavbarItem[]}
+ */
+export const SocialNavbarItems = /** @type {const} */ ([
+    {
+        "href": SocialURL.GitHub,
+        "data-icon": "github",
+        "aria-label": "GitHub",
+        "position": "right",
+    },
+    {
+        "href": SocialURL.Discord,
+        "data-icon": "discord",
+        "aria-label": "Discord",
+        "position": "right",
+    },
+]);
+
+/**
+ * The navbar items for the authentik website.
+ *
+ * @satisfies {NavbarItem[]}
+ */
+export const NavbarItemsTemplate = /** @type {const} */ ([
+    {
+        to: "{{WWW_URL}}/features",
+        label: "Features",
+        position: "left",
+        target: "_self",
+    },
+    {
+        to: "{{INTEGRATIONS_URL}}",
+        label: "Integrations",
+        target: "_self",
+        position: "left",
+    },
+    {
+        to: "{{DOCS_URL}}",
+
+        label: "Documentation",
+        position: "left",
+        target: "_self",
+    },
+    {
+        to: "{{WWW_URL}}/pricing/",
+        label: "Pricing",
+        position: "left",
+        target: "_self",
+    },
+    {
+        to: "{{WWW_URL}}/blog",
+        label: "Blog",
+        position: "left",
+        target: "_self",
+    },
+    ...SocialNavbarItems,
+]);
+
+/**
+ * @typedef {Object} NavbarItemOverrides
+ *
+ * @prop {string} WWW_URL The URL for the WWW environment.
+ * @prop {string} DOCS_URL The URL for the documentation.
+ * @prop {string} INTEGRATIONS_URL The URL for the integrations.
+ */
+
+const DEFAULT_NAVBAR_REPLACEMENTS = /** @type {const} */ ({
+    DOCS_URL: DocusaurusURL.Docs,
+    INTEGRATIONS_URL: DocusaurusURL.Integrations,
+    WWW_URL: DocusaurusURL.WWW,
+});
+
+/**
+ * Creates a navbar item array, replacing placeholders with the given replacements.
+ *
+ * @param {Partial<NavbarItemOverrides>} [overrides]
+ * @returns {NavbarItem[]}
+ */
+export function createNavbarItems(overrides) {
+    const replacements = {
+        ...DEFAULT_NAVBAR_REPLACEMENTS,
+        ...overrides,
+    };
+
+    return NavbarItemsTemplate.map((item) => {
+        if (typeof item.to !== "string") return item;
+
+        return {
+            ...item,
+            to: item.to.replace(
+                /{{([^}]+)}}/g,
+                /**
+                 * @param {keyof NavbarItemOverrides}  key
+                 */
+                (_, key) => {
+                    return replacements[key];
+                },
+            ),
+        };
+    });
+}

package/lib/routing.js

@@ -0,0 +1,35 @@
+/**
+ * @file Docusaurus routing configuration.
+ */
+
+/**
+ * @typedef {'production'|'development'} NodeEnvironment
+ */
+
+const NodeEnvironment = /** @type {NodeEnvironment} */ (process.env.NODE_ENV || "development");
+
+/**
+ * @satisfies {Record<NodeEnvironment, Record<string, string>>}
+ */
+export const DocusaurusURLByEnvironment = /** @type {const} */ ({
+    development: {
+        Docs: "http://localhost:3000",
+        Integrations: "http://localhost:3001",
+        WWW: "http://localhost:3002",
+    },
+    production: {
+        Docs: "https://docs.goauthentik.io",
+        Integrations: "https://integrations.goauthentik.io",
+        WWW: "https://goauthentik.io",
+    },
+});
+
+export const DocusaurusURL = DocusaurusURLByEnvironment[NodeEnvironment];
+
+/**
+ * @satisfies {Record<string, string>}
+ */
+export const SocialURL = /** @type {const} */ ({
+    Discord: "https://goauthentik.io/discord",
+    GitHub: "https://github.com/goauthentik/authentik",
+});

package/lib/theme.js

@@ -3,16 +3,26 @@
  *
  * @import { UserThemeConfig as UserThemeConfigCommon } from "@docusaurus/theme-common";
  * @import { UserThemeConfig as UserThemeConfigAlgolia } from "@docusaurus/theme-search-algolia";
+ * @import { NavbarItemOverrides } from "./navbar.js"
  */
 import { deepmerge } from "deepmerge-ts";
 import { themes as prismThemes } from "prism-react-renderer";
 
+import { createNavbarItems } from "./navbar.js";
+
 //#region Types
 
 /**
- * Combined theme configuration for Docusaurus and Algolia.
+ * @typedef {Object} UserThemeConfigExtra
+ * @property {Partial<NavbarItemOverrides>} [navbarReplacements] The replacements for the navbar.
+ *
+ */
+
+/**
+ * Combined theme configuration for Docusaurus, Algolia, and our own configuration.
  *
  * @typedef {UserThemeConfigCommon & UserThemeConfigAlgolia} UserThemeConfig
+ *
  */
 
 //#endregion
@@ -48,6 +58,7 @@ export function createPrismConfig(overrides = {}) {
             "nginx",
             "python",
             "bash",
+            "powershell",
         ],
     };
 
@@ -57,10 +68,10 @@ export function createPrismConfig(overrides = {}) {
 /**
  * Creates a theme configuration for Docusaurus.
  *
- * @param {Partial<UserThemeConfig>} overrides - Overrides for the default theme configuration.
+ * @param {Partial<UserThemeConfig & UserThemeConfigExtra>} overrides - Overrides for the default theme configuration.
  * @returns {UserThemeConfig}
  */
-export function createThemeConfig({ prism, ...overrides } = {}) {
+export function createThemeConfig({ prism, navbarReplacements, ...overrides } = {}) {
     /**
      * @type {UserThemeConfig}
      */
@@ -77,6 +88,17 @@ export function createThemeConfig({ prism, ...overrides } = {}) {
             appId: "36ROD0O0FV",
             apiKey: "727db511300ca9aec5425645bbbddfb5",
         },
+        footer: {
+            copyright: `Copyright © ${new Date().getFullYear()} Authentik Security Inc. Built with Docusaurus.`,
+        },
+        navbar: {
+            logo: {
+                alt: "authentik logo",
+                src: "img/icon_left_brand.svg",
+            },
+
+            items: createNavbarItems(navbarReplacements),
+        },
         prism: createPrismConfig(prism),
     };
 

package/out/index.d.ts

@@ -1,3 +1,5 @@
 export * from "./lib/theme.js";
 export * from "./lib/common.js";
+export * from "./lib/routing.js";
+export * from "./lib/navbar.js";
 //# sourceMappingURL=index.d.ts.map

package/out/lib/common.d.ts

@@ -1,11 +1,11 @@
 /**
- * @typedef {Omit<DocusaurusConfig, 'themeConfig'>} DocusaurusConfigBase
+ * @typedef {Omit<Config, 'themeConfig'>} DocusaurusConfigBase
  *
  * Represents the base configuration for Docusaurus, excluding the theme configuration.
  */
 /**
  * @typedef DocusaurusConfigBaseTheme
- * @property {UserThemeConfig} themeConfig The theme configuration.
+ * @property {UserThemeConfig & UserThemeConfigExtra} themeConfig The theme configuration.
  *
  * Represents a configuration object, only including the theme configuration.
  */
@@ -19,29 +19,67 @@
  * Much of the configuration is not strictly typed, however, this type
  * is a good starting point.
  */
+/**
+ * Create a default Docusaurus configuration.
+ */
+export function createDefaultDocusaurusConfig(): {
+    readonly trailingSlash: true;
+    readonly future: {
+        readonly v4: {
+            readonly removeLegacyPostBuildHeadAttribute: true;
+            readonly useCssCascadeLayers: false;
+        };
+        readonly experimental_faster: {
+            readonly swcJsLoader: true;
+            readonly rspackBundler: true;
+            readonly lightningCssMinimizer: boolean;
+            readonly swcJsMinimizer: boolean;
+            readonly swcHtmlMinimizer: boolean;
+            readonly ssgWorkerThreads: boolean;
+            readonly mdxCrossCompilerCache: boolean;
+            readonly rspackPersistentCache: boolean;
+        };
+    };
+    readonly title: "authentik";
+    readonly tagline: "Bring all of your authentication into a unified platform.";
+    readonly url: "https://docs.goauthentik.io";
+    readonly baseUrl: "/";
+    readonly onBrokenLinks: "throw";
+    readonly onBrokenAnchors: "throw";
+    readonly onBrokenMarkdownLinks: "throw";
+    readonly onDuplicateRoutes: "throw";
+    readonly favicon: "img/icon.png";
+    readonly organizationName: "Authentik Security Inc.";
+    readonly projectName: "authentik";
+    readonly markdown: {
+        readonly mermaid: true;
+    };
+};
 /**
  * Create a Docusaurus configuration.
  *
- * @param {DocusaurusConfigInit} [overrides] The options to override.
- * @returns {DocusaurusConfig}
+ * @template {Partial<Config>} T
+ * @param {T} overrides The options to override.
+ * @returns {T & ReturnType<typeof createDefaultDocusaurusConfig>}
  */
-export function createDocusaurusConfig({ themeConfig, ...overrides }?: DocusaurusConfigInit): DocusaurusConfig;
+export function createDocusaurusConfig<T extends Partial<Config>>({ themeConfig, ...overrides }: T): T & ReturnType<typeof createDefaultDocusaurusConfig>;
 /**
  * Represents the base configuration for Docusaurus, excluding the theme configuration.
  */
-export type DocusaurusConfigBase = Omit<DocusaurusConfig, "themeConfig">;
+export type DocusaurusConfigBase = Omit<Config, "themeConfig">;
 export type DocusaurusConfigBaseTheme = {
     /**
      * The theme configuration.
      *
      * Represents a configuration object, only including the theme configuration.
      */
-    themeConfig: UserThemeConfig;
+    themeConfig: UserThemeConfig & UserThemeConfigExtra;
 };
 /**
  * The initial configuration for Docusaurus.
  */
 export type DocusaurusConfigInit = Partial<DocusaurusConfigBase & DocusaurusConfigBaseTheme>;
-import type { Config as DocusaurusConfig } from "@docusaurus/types";
+import type { Config } from "@docusaurus/types";
 import type { UserThemeConfig } from "./theme.js";
+import type { UserThemeConfigExtra } from "./theme.js";
 //# sourceMappingURL=common.d.ts.map

package/out/lib/common.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../lib/common.js"],"names":[],"mappings":"AAYA;;;;GAIG;AAEH;;;;;GAKG;AAEH;;;;;;;;;GASG;AAMH;;;;;GAKG;AACH,uEAHW,oBAAoB,GAClB,gBAAgB,CAuB5B;;;;mCAtDY,IAAI,CAAC,gBAAgB,EAAE,aAAa,CAAC;;;;;;;iBAOpC,eAAe;;;;;mCAMhB,OAAO,CAAC,oBAAoB,GAAG,yBAAyB,CAAC;gDAvBvB,mBAAmB;qCAC9B,YAAY"}
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../lib/common.js"],"names":[],"mappings":"AAYA;;;;GAIG;AAEH;;;;;GAKG;AAEH;;;;;;;;;GASG;AAMH;;GAEG;AACH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA0CC;AAED;;;;;;GAMG;AACH,uCAJ+B,CAAC,SAAlB,OAAO,CAAC,MAAM,CAAE,iCACnB,CAAC,GACC,CAAC,GAAG,UAAU,CAAC,OAAO,6BAA6B,CAAC,CAUhE;;;;mCAzFY,IAAI,CAAC,MAAM,EAAE,aAAa,CAAC;;;;;;;iBAO1B,eAAe,GAAG,oBAAoB;;;;;mCAMvC,OAAO,CAAC,oBAAoB,GAAG,yBAAyB,CAAC;4BAvBzB,mBAAmB;qCACN,YAAY;0CAAZ,YAAY"}

package/out/lib/navbar.d.ts

@@ -0,0 +1,60 @@
+/**
+ * Creates a navbar item array, replacing placeholders with the given replacements.
+ *
+ * @param {Partial<NavbarItemOverrides>} [overrides]
+ * @returns {NavbarItem[]}
+ */
+export function createNavbarItems(overrides?: Partial<NavbarItemOverrides>): NavbarItem[];
+/**
+ * The navbar items for the authentik website.
+ *
+ * @type {NavbarItem[]}
+ */
+export const SocialNavbarItems: NavbarItem[];
+/**
+ * The navbar items for the authentik website.
+ *
+ * @satisfies {NavbarItem[]}
+ */
+export const NavbarItemsTemplate: [{
+    readonly to: "{{WWW_URL}}/features";
+    readonly label: "Features";
+    readonly position: "left";
+    readonly target: "_self";
+}, {
+    readonly to: "{{INTEGRATIONS_URL}}";
+    readonly label: "Integrations";
+    readonly target: "_self";
+    readonly position: "left";
+}, {
+    readonly to: "{{DOCS_URL}}";
+    readonly label: "Documentation";
+    readonly position: "left";
+    readonly target: "_self";
+}, {
+    readonly to: "{{WWW_URL}}/pricing/";
+    readonly label: "Pricing";
+    readonly position: "left";
+    readonly target: "_self";
+}, {
+    readonly to: "{{WWW_URL}}/blog";
+    readonly label: "Blog";
+    readonly position: "left";
+    readonly target: "_self";
+}, ...NavbarItem[]];
+export type NavbarItemOverrides = {
+    /**
+     * The URL for the WWW environment.
+     */
+    WWW_URL: string;
+    /**
+     * The URL for the documentation.
+     */
+    DOCS_URL: string;
+    /**
+     * The URL for the integrations.
+     */
+    INTEGRATIONS_URL: string;
+};
+import type { NavbarItem } from "@docusaurus/theme-common";
+//# sourceMappingURL=navbar.d.ts.map

package/out/lib/navbar.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"navbar.d.ts","sourceRoot":"","sources":["../../lib/navbar.js"],"names":[],"mappings":"AAiFA;;;;;GAKG;AACH,8CAHW,OAAO,CAAC,mBAAmB,CAAC,GAC1B,UAAU,EAAE,CAwBxB;AAtGD;;;;GAIG;AACH,gCAFU,UAAU,EAAE,CAenB;AAEH;;;;GAIG;AACH;;;;;;;;;;;;;;;;;;;;;;;;;oBAiCG;;;;;aAKO,MAAM;;;;cACN,MAAM;;;;sBACN,MAAM;;gCArEe,0BAA0B"}

package/out/lib/routing.d.ts

@@ -0,0 +1,30 @@
+export namespace DocusaurusURLByEnvironment {
+    namespace development {
+        let Docs: "http://localhost:3000";
+        let Integrations: "http://localhost:3001";
+        let WWW: "http://localhost:3002";
+    }
+    namespace production {
+        let Docs_1: "https://docs.goauthentik.io";
+        export { Docs_1 as Docs };
+        let Integrations_1: "https://integrations.goauthentik.io";
+        export { Integrations_1 as Integrations };
+        let WWW_1: "https://goauthentik.io";
+        export { WWW_1 as WWW };
+    }
+}
+export const DocusaurusURL: {
+    readonly Docs: "http://localhost:3000";
+    readonly Integrations: "http://localhost:3001";
+    readonly WWW: "http://localhost:3002";
+} | {
+    readonly Docs: "https://docs.goauthentik.io";
+    readonly Integrations: "https://integrations.goauthentik.io";
+    readonly WWW: "https://goauthentik.io";
+};
+export namespace SocialURL {
+    let Discord: "https://goauthentik.io/discord";
+    let GitHub: "https://github.com/goauthentik/authentik";
+}
+export type NodeEnvironment = "production" | "development";
+//# sourceMappingURL=routing.d.ts.map

package/out/lib/routing.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"routing.d.ts","sourceRoot":"","sources":["../../lib/routing.js"],"names":[],"mappings":";;;;;;;;;;;;;;;AA0BA;;;;;;;;EAAyE;;;;;8BArB5D,YAAY,GAAC,aAAa"}

package/out/lib/theme.d.ts

@@ -1,7 +1,13 @@
 /**
- * Combined theme configuration for Docusaurus and Algolia.
+ * @typedef {Object} UserThemeConfigExtra
+ * @property {Partial<NavbarItemOverrides>} [navbarReplacements] The replacements for the navbar.
+ *
+ */
+/**
+ * Combined theme configuration for Docusaurus, Algolia, and our own configuration.
  *
  * @typedef {UserThemeConfigCommon & UserThemeConfigAlgolia} UserThemeConfig
+ *
  */
 /**
  * @returns {string} The copyright string.
@@ -17,14 +23,21 @@ export function createPrismConfig(overrides?: Partial<UserThemeConfigCommon["pri
 /**
  * Creates a theme configuration for Docusaurus.
  *
- * @param {Partial<UserThemeConfig>} overrides - Overrides for the default theme configuration.
+ * @param {Partial<UserThemeConfig & UserThemeConfigExtra>} overrides - Overrides for the default theme configuration.
  * @returns {UserThemeConfig}
  */
-export function createThemeConfig({ prism, ...overrides }?: Partial<UserThemeConfig>): UserThemeConfig;
+export function createThemeConfig({ prism, navbarReplacements, ...overrides }?: Partial<UserThemeConfig & UserThemeConfigExtra>): UserThemeConfig;
+export type UserThemeConfigExtra = {
+    /**
+     * The replacements for the navbar.
+     */
+    navbarReplacements?: Partial<NavbarItemOverrides> | undefined;
+};
 /**
- * Combined theme configuration for Docusaurus and Algolia.
+ * Combined theme configuration for Docusaurus, Algolia, and our own configuration.
  */
 export type UserThemeConfig = UserThemeConfigCommon & UserThemeConfigAlgolia;
 import type { UserThemeConfig as UserThemeConfigCommon } from "@docusaurus/theme-common";
+import type { NavbarItemOverrides } from "./navbar.js";
 import type { UserThemeConfig as UserThemeConfigAlgolia } from "@docusaurus/theme-search-algolia";
 //# sourceMappingURL=theme.d.ts.map

package/out/lib/theme.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"theme.d.ts","sourceRoot":"","sources":["../../lib/theme.js"],"names":[],"mappings":"AAWA;;;;GAIG;AAMH;;GAEG;AACH,mCAFa,MAAM,CAIlB;AAED;;;;;GAKG;AACH,8CAHW,OAAO,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC,GACrC,qBAAqB,CAAC,OAAO,CAAC,CAsB1C;AAED;;;;;GAKG;AACH,4DAHW,OAAO,CAAC,eAAe,CAAC,GACtB,eAAe,CAuB3B;;;;8BArEY,qBAAqB,GAAG,sBAAsB;8DAXE,0BAA0B;+DACzB,kCAAkC"}
+{"version":3,"file":"theme.d.ts","sourceRoot":"","sources":["../../lib/theme.js"],"names":[],"mappings":"AAcA;;;;GAIG;AAEH;;;;;GAKG;AAMH;;GAEG;AACH,mCAFa,MAAM,CAIlB;AAED;;;;;GAKG;AACH,8CAHW,OAAO,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC,GACrC,qBAAqB,CAAC,OAAO,CAAC,CAuB1C;AAED;;;;;GAKG;AACH,gFAHW,OAAO,CAAC,eAAe,GAAG,oBAAoB,CAAC,GAC7C,eAAe,CAkC3B;;;;;;;;;;8BAlFY,qBAAqB,GAAG,sBAAsB;8DApBE,0BAA0B;yCAE/C,aAAa;+DADS,kCAAkC"}