fix: outputFolder is optional

Forsakringskassan · Nov 4, 2024 · 53dde23 · 53dde23
1 parent e4ad918
commit 53dde23
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 5 deletions.
diff --git a/etc/index.api.md b/etc/index.api.md
@@ -107,8 +107,7 @@ export interface GeneratorOptions {
             title?: Record<string, string>;
         };
     };
-    // (undocumented)
-    outputFolder: string;
+    outputFolder?: string;
     processors?: Processor[];
     setupPath: string;
     site: GeneratorSiteOptions;

diff --git a/src/generator.ts b/src/generator.ts
@@ -52,7 +52,8 @@ export interface GeneratorOptions {
     /** Site options */
     site: GeneratorSiteOptions;
 
-    outputFolder: string;
+    /** Output folder. Default: `public` */
+    outputFolder?: string;
 
     /** Where cached content is stored. Default: `temp/docs` */
     cacheFolder?: string;
@@ -299,9 +300,9 @@ export class Generator {
         }
 
         this.site = options.site;
-        this.outputFolder = options.outputFolder;
+        this.outputFolder = options.outputFolder ?? "./public";
         this.cacheFolder = options.cacheFolder ?? "./temp/docs";
-        this.assetFolder = path.posix.join(options.outputFolder, "assets");
+        this.assetFolder = path.posix.join(this.outputFolder, "assets");
         this.exampleFolders = options.exampleFolders ?? [];
         this.templateFolders = options.templateFolders ?? [];
         this.processors = options.processors ?? [];