@forsakringskassan/docs-generator 1.25.2 → 1.26.0

package/dist/generator.d.ts

@@ -88,7 +88,13 @@ export declare interface FileInfo {
     name: string;
     /** path relative to project root */
     fullPath: string;
-    /** output filename or `false` to disable writing result to a file */
+    /**
+     * Output filename or `false` to disable writing result to a file.
+     *
+     * When passing a filename these optional placeholders can be used:
+     *
+     * - `[hash]` - replaced with the hash of the content body.
+     */
     outputName: string | false;
 }
 
@@ -132,6 +138,16 @@ declare class Generator_2 {
      * @param src - File or directory to copy.
      */
     copyResource(dst: string, src: string): void;
+    /**
+     * Generate a manifest listing all generated documents that will be present
+     * in `outputFolder`.
+     *
+     * Note: this only collects documents from the `generate-docs` stage,
+     * potential documents generated at later stages will not be present.
+     *
+     * @public
+     */
+    manifest(sourceFiles: SourceFiles[]): Promise<Manifest>;
     build(sourceFiles: SourceFiles[]): Promise<string[]>;
     /**
      * Start a development server hosting the generated documentation.
@@ -178,6 +194,45 @@ export declare interface GeneratorSiteOptions {
  */
 export declare function livereloadProcessor(options: ProcessorOptions): Processor;
 
+/**
+ * @public
+ */
+export declare interface Manifest {
+    pages: Array<{
+        path: string;
+        title: string;
+        outline: Array<{
+            heading: string;
+            anchor: string;
+        }>;
+        examples: Array<{
+            selector: string;
+            language: string;
+            tags: string[];
+        }>;
+    }>;
+}
+
+/**
+ * Write out a manifest listing all generated documents that will be present in
+ * `outputFolder`.
+ *
+ * @public
+ */
+export declare function manifestProcessor(options: ManifestProcessorOptions): Processor;
+
+/**
+ * Options for {@link manifestProcessor}.
+ *
+ * @public
+ */
+export declare interface ManifestProcessorOptions {
+    /** If set, the manifest will be written as Markdown to this destination */
+    markdown?: string;
+    /** If set, the manifest will be written as JSON to this destination */
+    json?: string;
+}
+
 /**
  * @public
  */