docula 0.90.0 → 1.1.0

package/dist/docula.d.ts

@@ -70,6 +70,21 @@ type GithubData = {
     contributors: Record<string, unknown>;
 };
 
+type DoculaCookieAuth = {
+    loginUrl: string;
+    cookieName?: string;
+    logoutUrl?: string;
+};
+type DoculaHeaderLink = {
+    label: string;
+    url: string;
+    icon?: string;
+};
+type DoculaCacheOptions = {
+    github: {
+        ttl: number;
+    };
+};
 declare class DoculaOptions {
     /**
      * Name of the built-in template to use (e.g., "modern", "classic")
@@ -142,6 +157,29 @@ declare class DoculaOptions {
      * site directory's .gitignore file if not already present.
      */
     autoUpdateIgnores: boolean;
+    /**
+     * File extensions to copy as assets from docs/ and changelog/ directories.
+     * Override in docula.config to customize.
+     */
+    /**
+     * Cookie-based authentication. When set, shows a Login/Logout button
+     * in the header based on whether a JWT cookie is present.
+     */
+    cookieAuth?: DoculaCookieAuth;
+    /**
+     * Additional links to display in the site header navigation.
+     * Each link requires a label and url.
+     */
+    headerLinks?: DoculaHeaderLink[];
+    /**
+     * File extensions to copy as assets from docs/ and changelog/ directories.
+     * Override in docula.config to customize.
+     */
+    /**
+     * Cache settings. Controls caching of external data (e.g., GitHub API responses)
+     * in the .cache directory within the site path.
+     */
+    cache: DoculaCacheOptions;
     /**
      * File extensions to copy as assets from docs/ and changelog/ directories.
      * Override in docula.config to customize.
@@ -184,6 +222,16 @@ type DoculaData = {
     changelogEntries?: DoculaChangelogEntry[];
     homePage?: boolean;
     themeMode?: string;
+    cookieAuth?: {
+        loginUrl: string;
+        cookieName?: string;
+        logoutUrl?: string;
+    };
+    headerLinks?: Array<{
+        label: string;
+        url: string;
+        icon?: string;
+    }>;
 };
 type DoculaTemplates = {
     home: string;
@@ -359,4 +407,4 @@ declare class Docula {
     serve(options: DoculaOptions): Promise<http.Server>;
 }
 
-export { DoculaOptions, Docula as default };
+export { type DoculaCacheOptions, type DoculaCookieAuth, type DoculaHeaderLink, DoculaOptions, Docula as default };