@forsakringskassan/docs-generator 1.28.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/{create-markdown-renderer-CPrI2LLQ.js → create-markdown-renderer-D1cATjO1.js}

@@ -559,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/index.js

@@ -3,7 +3,7 @@
 var fs = require('node:fs/promises');
 var path = require('node:path');
 var vendor = require('./vendor-uab7h6x-.js');
-var createMarkdownRenderer = require('./create-markdown-renderer-CPrI2LLQ.js');
+var createMarkdownRenderer = require('./create-markdown-renderer-D1cATjO1.js');
 var require$$1 = require('crypto');
 require('node:crypto');
 var vueDocgenApi = require('vue-docgen-api');
@@ -220,6 +220,7 @@ function parseFile$1(filePath, basePath, content) {
   const name = attributes.name ? attributes.name : parsed.name;
   const urlpath = parsed.dir;
   const outline = getDocumentOutline(blocks.body);
+  const include = attributes.include ?? true;
   return {
     id: `fs:${filePath.replace(/\\/g, "/")}`,
     name,
@@ -242,7 +243,7 @@ function parseFile$1(filePath, basePath, content) {
       path: ["", "."].includes(urlpath) ? "." : `./${createMarkdownRenderer.normalizePath(urlpath)}`,
       name: filename,
       fullPath: createMarkdownRenderer.normalizePath(filePath),
-      outputName: `${filename}.html`
+      outputName: include ? `${filename}.html` : false
     }
   };
 }
@@ -1177,6 +1178,9 @@ async function compileExamples(options) {
   const outputFolder = path.posix.join(options.outputFolder, fileInfo.path);
   const cacheMiss = cache(cacheFolder, outputFolder);
   const dirtyTasks = tasks.filter(cacheMiss);
+  if (dirtyTasks.length === 0) {
+    return;
+  }
   const batch = {
     outputFolder,
     external: vendors.map((it) => it.package),

package/dist/markdown.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var createMarkdownRenderer = require('./create-markdown-renderer-CPrI2LLQ.js');
+var createMarkdownRenderer = require('./create-markdown-renderer-D1cATjO1.js');
 require('./vendor-uab7h6x-.js');
 require('path');
 require('url');

package/dist/style/core.css

@@ -410,21 +410,21 @@ p:not(.code-preview p) {
   max-width: 680px;
 }
 
-main h1:not(.code-preview--default h1) {
+main h1:not(.code-preview h1) {
   font-size: 2.5rem;
   color: #1b1e23;
 }
 
-main h2:not(.code-preview--default h2) {
+main h2:not(.code-preview h2) {
   font-size: 1.5rem;
   margin-top: 3rem;
 }
 
-main h3:not(.code-preview--default h3) {
+main h3:not(.code-preview h3) {
   font-size: 1.2rem;
 }
 
-main h4:not(.code-preview--default h4) {
+main h4:not(.code-preview h4) {
   font-size: 1rem;
 }
 
@@ -478,6 +478,23 @@ h1 code {
   font-weight: 400;
 }
 
+#content a:not(.code-preview a) {
+  color: var(--docs-text-color-default);
+}
+
+#content a:not(.code-preview a, h2 a, h3 a, h4 a, h5 a) {
+  text-decoration: underline;
+  text-decoration-thickness: 1px;
+  color: var(--f-text-color-link);
+  text-decoration-color: var(--docs-text-color-link);
+  text-underline-offset: 0.15rem;
+}
+
+#content a:hover:not(.code-preview a, h2 a, h3 a, h4 a, h5 a) {
+  color: var(--f-text-color-default);
+  text-decoration-color: var(--docs-text-link-hover);
+}
+
 .layout-wrapper {
   font-family: var(--docs-font-family);
   background: #fff;

package/dist/style/index.css

@@ -410,21 +410,21 @@ p:not(.code-preview p) {
   max-width: 680px;
 }
 
-main h1:not(.code-preview--default h1) {
+main h1:not(.code-preview h1) {
   font-size: 2.5rem;
   color: #1b1e23;
 }
 
-main h2:not(.code-preview--default h2) {
+main h2:not(.code-preview h2) {
   font-size: 1.5rem;
   margin-top: 3rem;
 }
 
-main h3:not(.code-preview--default h3) {
+main h3:not(.code-preview h3) {
   font-size: 1.2rem;
 }
 
-main h4:not(.code-preview--default h4) {
+main h4:not(.code-preview h4) {
   font-size: 1rem;
 }
 
@@ -478,6 +478,23 @@ h1 code {
   font-weight: 400;
 }
 
+#content a:not(.code-preview a) {
+  color: var(--docs-text-color-default);
+}
+
+#content a:not(.code-preview a, h2 a, h3 a, h4 a, h5 a) {
+  text-decoration: underline;
+  text-decoration-thickness: 1px;
+  color: var(--f-text-color-link);
+  text-decoration-color: var(--docs-text-color-link);
+  text-underline-offset: 0.15rem;
+}
+
+#content a:hover:not(.code-preview a, h2 a, h3 a, h4 a, h5 a) {
+  color: var(--f-text-color-default);
+  text-decoration-color: var(--docs-text-link-hover);
+}
+
 .layout-wrapper {
   font-family: var(--docs-font-family);
   background: #fff;
@@ -841,6 +858,8 @@ kbd {
   --docs-font-weight: normal;
   --docs-text-color-default: #1b1e23;
   --docs-text-color-discrete: #5f6165;
+  --docs-text-color-link: #4a52b6;
+  --docs-text-color-link-hover: #1b1e23;
   --docs-heading-font-family: var(--docs-font-family);
   --docs-heading-font-weight: var(--docs-font-weight);
   --docs-heading-line-height: 1.4;

package/dist/style/site.css

@@ -3,6 +3,8 @@
   --docs-font-weight: normal;
   --docs-text-color-default: #1b1e23;
   --docs-text-color-discrete: #5f6165;
+  --docs-text-color-link: #4a52b6;
+  --docs-text-color-link-hover: #1b1e23;
   --docs-heading-font-family: var(--docs-font-family);
   --docs-heading-font-weight: var(--docs-font-weight);
   --docs-heading-line-height: 1.4;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forsakringskassan/docs-generator",
-  "version": "1.28.0",
+  "version": "1.29.0",
   "description": "Documentation generator",
   "keywords": [
     "documentation"