@forsakringskassan/docs-generator 1.27.0 → 1.29.0

package/README.md

@@ -228,6 +228,11 @@ Document title used for `<title>` and `<nav>`
 Set to `false` to hide document from navigation menu.
 Default `true`.
 
+#### `include`
+
+Set to `false` to not write the document to file or include as a page.
+Default `true`.
+
 ### Inline tags
 
 #### `{@link ...}`

package/dist/compile-example.js

@@ -3,21 +3,21 @@
 var path$1 = require('node:path');
 var esbuild = require('esbuild');
 var vue = require('vue');
-var vue2 = require('./vue2-DYKDshbg.js');
-var vue3 = require('./vue3-CEA3zw16.js');
+var vue2 = require('./vue2-CBDrnmVO.js');
+var vue3 = require('./vue3-xJIC7Aol.js');
 var path = require('node:path/posix');
 require('@vue/compiler-sfc');
-require('./vendor-Dmnzl4fQ.js');
-require('fs');
-require('constants');
-require('stream');
-require('util');
-require('assert');
+require('./vendor-uab7h6x-.js');
 require('path');
 require('url');
+require('fs');
 require('fs/promises');
 require('events');
+require('stream');
 require('string_decoder');
+require('constants');
+require('util');
+require('assert');
 require('readline');
 require('child_process');
 require('node:buffer');

package/dist/{create-markdown-renderer--V6N9Daq.js → create-markdown-renderer-D1cATjO1.js}

@@ -1,6 +1,6 @@
 'use strict';
 
-var vendor = require('./vendor-Dmnzl4fQ.js');
+var vendor = require('./vendor-uab7h6x-.js');
 var path = require('node:path/posix');
 require('node:path');
 require('crypto');
@@ -277,7 +277,14 @@ function codePreview(options) {
     const fullscreen = tags.includes("fullscreen");
     const modifier = getClassModifier(tags);
     const standalone = Boolean(example.output) && fullscreen;
-    const testIdAttr = testId ? ` data-test="${testId}"` : "";
+    const testIdAttr = testId ? `data-test="${testId}"` : "";
+    const filteredTags = tags.filter((it) => {
+      if (it.startsWith("test-id=")) {
+        return false;
+      }
+      return true;
+    });
+    const dataTagsAttr = filteredTags.length > 0 ? `data-tags=${filteredTags.join(" ")}` : "";
     if (liveExample) {
       return (
         /* HTML */
@@ -286,6 +293,8 @@ function codePreview(options) {
                     id="example-${fingerprint}"
                     class="code-preview code-preview--borderless"
                     ${testIdAttr}
+                    ${dataTagsAttr}
+                    data-language="${example.language}"
                 >
                     ${example.markup}
                 </div>
@@ -300,6 +309,8 @@ function codePreview(options) {
                     id="example-${fingerprint}"
                     class="code-preview ${modifier}"
                     ${testIdAttr}
+                    ${dataTagsAttr}
+                    data-language="${example.language}"
                 >
                     ${example.comments.join("\n")}
                     <pre class="code-preview__markup">${highlightedCode}</pre>
@@ -315,6 +326,8 @@ function codePreview(options) {
                     id="example-${fingerprint}"
                     class="code-preview ${modifier}"
                     ${testIdAttr}
+                    ${dataTagsAttr}
+                    data-language="${example.language}"
                 >
                     ${example.comments.join("\n")}
                     <div class="code-preview__preview">${example.markup}</div>
@@ -352,6 +365,8 @@ function codePreview(options) {
                 id="example-${fingerprint}"
                 class="code-preview ${modifier}"
                 ${testIdAttr}
+                ${dataTagsAttr}
+                data-language="${example.language}"
             >
                 ${example.comments.join("\n")}
                 <div class="code-preview__preview">${example.markup}</div>
@@ -544,6 +559,15 @@ function include(docs, env, included, handleSoftError) {
           /* HTML */
           ` <div>${content}</div> `
         );
+      },
+      alt(tokens, index) {
+        const token = tokens[index];
+        const needle = token.info.split(" ")[1];
+        const doc = findDocument(docs, needle);
+        if (doc && doc.format === "markdown") {
+          return md.render(doc.body, env);
+        }
+        return md.render(token.content, env);
       }
     });
   };

package/dist/{generator.d.ts → index.d.ts}

@@ -26,6 +26,13 @@ export declare interface CompileOptions {
     attributes: AttributeTable;
 }
 
+/**
+ * Tiny wrapper to provide type completion for IDE.
+ *
+ * @public
+ */
+export declare function defineSources(sources: SourceFiles[]): SourceFiles[];
+
 /**
  * @public
  */
@@ -332,7 +339,7 @@ export declare interface ProcessorContext {
      * @param id - A unique identifier for this block.
      * @param renderer - Describes how to render the block content.
      */
-    addTemplateBlock(container: string, id: string, renderer: TemplateBlockRenderer): void;
+    addTemplateBlock<T>(container: string, id: string, renderer: TemplateBlockRenderer<T>): void;
     /* Excluded from this release type: getAllTemplateBlocks */
     setTopNavigation(root: NavigationSection): void;
     setSideNavigation(root: NavigationSection): void;
@@ -444,9 +451,9 @@ export declare interface SourceFiles {
  *
  * @public
  */
-export declare type TemplateBlockRenderer = {
+export declare type TemplateBlockRenderer<T> = {
     filename: string;
-    data?: Record<string, unknown>;
+    data?: T;
 } | {
     render(): string;
 };
@@ -464,6 +471,26 @@ export declare interface TemplateData {
  */
 export declare function themeSelectProcessor(): Processor;
 
+/**
+ * Single entry for a topnav item.
+ *
+ * @public
+ */
+export declare interface TopnavEntry {
+    path: string;
+    title: string;
+}
+
+/**
+ * Processor to create a manual topnav:
+ *
+ * - Custom order.
+ * - Custom items.
+ *
+ * @public
+ */
+export declare function topnavProcessor(filename: string, title: string): Processor;
+
 /**
  * Represents a compiled vendor asset.
  *
@@ -555,7 +582,21 @@ export declare function versionBannerProcessor(message: string, container: strin
 export declare function versionProcessor(pkg: {
     name: string;
     version: string;
-}, container: string): Processor;
+    homepage: string;
+}, container: string, options?: VersionProcessorOptions): Processor;
+
+/**
+ * Options for {@link versionProcessor}.
+ *
+ * @public
+ */
+export declare interface VersionProcessorOptions {
+    readonly enabled: boolean;
+    readonly scm?: {
+        readonly commitUrlFormat: string;
+        readonly prUrlFormat: string;
+    };
+}
 
 /**
  * Generate API documentation from a Vue SFC.