@forsakringskassan/docs-generator 1.29.2 → 1.30.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/compile-example.js +7 -5
- package/dist/{create-markdown-renderer-IsFf8Wbo.js → create-markdown-renderer-Bo7YoF2w.js} +1 -1
- package/dist/index.d.ts +25 -1
- package/dist/index.js +63 -30
- package/dist/markdown.js +8 -6
- package/dist/runtime.js +13 -1
- package/dist/tsdoc-metadata.json +1 -1
- package/dist/{vendor-D7cNMveZ.js → vendor-xbC24N4h.js} +215 -176
- package/dist/{vue3-DoboNqXW.js → vue3-CjV_X9qw.js} +1 -1
- package/package.json +2 -2
- package/templates/base.template.html +1 -1
- package/templates/macro/menu.html +9 -1
- package/templates/partials/search-toolbar.html +1 -1
- package/templates/partials/theme-render-blocker.html +11 -0
- package/templates/partials/theme-select.html +12 -31
package/dist/compile-example.js
CHANGED
|
@@ -4,22 +4,24 @@ var path$1 = require('node:path');
|
|
|
4
4
|
var esbuild = require('esbuild');
|
|
5
5
|
var vue = require('vue');
|
|
6
6
|
var vue2 = require('./vue2-BJo6OAwR.js');
|
|
7
|
-
var vue3 = require('./vue3-
|
|
7
|
+
var vue3 = require('./vue3-CjV_X9qw.js');
|
|
8
8
|
var path = require('node:path/posix');
|
|
9
9
|
require('@vue/compiler-sfc');
|
|
10
|
-
require('./vendor-
|
|
10
|
+
require('./vendor-xbC24N4h.js');
|
|
11
11
|
require('node:url');
|
|
12
12
|
require('fs');
|
|
13
13
|
require('node:fs');
|
|
14
14
|
require('node:fs/promises');
|
|
15
|
-
require('events');
|
|
16
|
-
require('stream');
|
|
17
|
-
require('string_decoder');
|
|
15
|
+
require('node:events');
|
|
16
|
+
require('node:stream');
|
|
17
|
+
require('node:string_decoder');
|
|
18
18
|
require('constants');
|
|
19
|
+
require('stream');
|
|
19
20
|
require('util');
|
|
20
21
|
require('assert');
|
|
21
22
|
require('path');
|
|
22
23
|
require('readline');
|
|
24
|
+
require('events');
|
|
23
25
|
require('child_process');
|
|
24
26
|
require('node:buffer');
|
|
25
27
|
require('node:child_process');
|
package/dist/index.d.ts
CHANGED
|
@@ -260,6 +260,27 @@ export declare interface MatomoOptions {
|
|
|
260
260
|
*/
|
|
261
261
|
export declare function matomoProcessor(options: MatomoOptions & ProcessorOptions): Processor;
|
|
262
262
|
|
|
263
|
+
/**
|
|
264
|
+
* Options for {@link motdProcessor}.
|
|
265
|
+
*
|
|
266
|
+
* @public
|
|
267
|
+
*/
|
|
268
|
+
export declare interface MOTDOptions {
|
|
269
|
+
/** Enables/disables the MOTD processor. */
|
|
270
|
+
enabled?: boolean;
|
|
271
|
+
/** Name of the container to render content in. */
|
|
272
|
+
container?: string;
|
|
273
|
+
/** Message to display */
|
|
274
|
+
message: string;
|
|
275
|
+
}
|
|
276
|
+
|
|
277
|
+
/**
|
|
278
|
+
* Display a MOTD style message.
|
|
279
|
+
*
|
|
280
|
+
* @public
|
|
281
|
+
*/
|
|
282
|
+
export declare function motdProcessor(options: MOTDOptions): Processor;
|
|
283
|
+
|
|
263
284
|
/**
|
|
264
285
|
* Read a JSON file with arbitrary navigation entries.
|
|
265
286
|
*
|
|
@@ -568,11 +589,14 @@ export declare interface VendorDefinitionDescriptor {
|
|
|
568
589
|
|
|
569
590
|
/**
|
|
570
591
|
* Display a banner with message when path dosen't start with /latest.
|
|
592
|
+
*
|
|
571
593
|
* @param message - Message to display in banner, may contain html-template.
|
|
594
|
+
* @param container - Where the content will be inserted.
|
|
572
595
|
*
|
|
573
596
|
* @public
|
|
597
|
+
* @deprecated Use the `motdProcessor` instead.
|
|
574
598
|
*/
|
|
575
|
-
export declare
|
|
599
|
+
export declare const versionBannerProcessor: (message: string, container: string) => Processor;
|
|
576
600
|
|
|
577
601
|
/**
|
|
578
602
|
* Injects the package name and version into the document.
|
package/dist/index.js
CHANGED
|
@@ -2,8 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
var fs = require('node:fs/promises');
|
|
4
4
|
var path = require('node:path');
|
|
5
|
-
var vendor = require('./vendor-
|
|
6
|
-
var createMarkdownRenderer = require('./create-markdown-renderer-
|
|
5
|
+
var vendor = require('./vendor-xbC24N4h.js');
|
|
6
|
+
var createMarkdownRenderer = require('./create-markdown-renderer-Bo7YoF2w.js');
|
|
7
7
|
var require$$1 = require('crypto');
|
|
8
8
|
require('node:crypto');
|
|
9
9
|
var vueDocgenApi = require('vue-docgen-api');
|
|
@@ -12,22 +12,24 @@ var fs$1 = require('node:fs');
|
|
|
12
12
|
var sass = require('sass');
|
|
13
13
|
var node_url = require('node:url');
|
|
14
14
|
var esbuild = require('esbuild');
|
|
15
|
-
var
|
|
15
|
+
var util = require('node:util');
|
|
16
16
|
var nunjucks = require('nunjucks');
|
|
17
17
|
var vue = require('vue');
|
|
18
18
|
var vue2 = require('./vue2-BJo6OAwR.js');
|
|
19
|
-
var vue3 = require('./vue3-
|
|
19
|
+
var vue3 = require('./vue3-CjV_X9qw.js');
|
|
20
20
|
var express = require('express');
|
|
21
21
|
var childProcess = require('node:child_process');
|
|
22
22
|
require('fs');
|
|
23
|
-
require('events');
|
|
24
|
-
require('stream');
|
|
25
|
-
require('string_decoder');
|
|
23
|
+
require('node:events');
|
|
24
|
+
require('node:stream');
|
|
25
|
+
require('node:string_decoder');
|
|
26
26
|
require('constants');
|
|
27
|
+
require('stream');
|
|
27
28
|
require('util');
|
|
28
29
|
require('assert');
|
|
29
30
|
require('path');
|
|
30
31
|
require('readline');
|
|
32
|
+
require('events');
|
|
31
33
|
require('child_process');
|
|
32
34
|
require('node:buffer');
|
|
33
35
|
require('node:process');
|
|
@@ -1230,7 +1232,7 @@ async function render(doc, docs, nav, vendors, options) {
|
|
|
1230
1232
|
sortNavigationTree(sidenav);
|
|
1231
1233
|
}
|
|
1232
1234
|
const njk = new nunjucks.Environment(loader, { autoescape: false });
|
|
1233
|
-
const asyncRender =
|
|
1235
|
+
const asyncRender = util.promisify(njk.render);
|
|
1234
1236
|
const renderTemplate = asyncRender.bind(njk);
|
|
1235
1237
|
const template = findTemplate(doc.fileInfo, doc);
|
|
1236
1238
|
const templateData = {
|
|
@@ -1238,6 +1240,11 @@ async function render(doc, docs, nav, vendors, options) {
|
|
|
1238
1240
|
site: options.site,
|
|
1239
1241
|
doc,
|
|
1240
1242
|
topnav,
|
|
1243
|
+
rootUrl(doc2) {
|
|
1244
|
+
const { fileInfo: fileInfo2 } = doc2;
|
|
1245
|
+
const relative = path$1.relative(fileInfo2.path, ".");
|
|
1246
|
+
return relative !== "" ? relative : ".";
|
|
1247
|
+
},
|
|
1241
1248
|
sidenav,
|
|
1242
1249
|
vendors
|
|
1243
1250
|
};
|
|
@@ -2021,13 +2028,58 @@ function manifestProcessor(options) {
|
|
|
2021
2028
|
};
|
|
2022
2029
|
}
|
|
2023
2030
|
|
|
2031
|
+
function normalizeOptions(options) {
|
|
2032
|
+
const defaults = {
|
|
2033
|
+
enabled: true,
|
|
2034
|
+
container: "body:begin"
|
|
2035
|
+
};
|
|
2036
|
+
return { ...defaults, ...options };
|
|
2037
|
+
}
|
|
2038
|
+
function motdProcessor(options) {
|
|
2039
|
+
const { enabled, container, message } = normalizeOptions(options);
|
|
2040
|
+
return {
|
|
2041
|
+
name: "motd-processor",
|
|
2042
|
+
after: "generate-docs",
|
|
2043
|
+
handler(context) {
|
|
2044
|
+
if (!enabled) {
|
|
2045
|
+
return;
|
|
2046
|
+
}
|
|
2047
|
+
context.addTemplateBlock(container, "version-banner", {
|
|
2048
|
+
filename: "partials/version-banner.html",
|
|
2049
|
+
data: { message }
|
|
2050
|
+
});
|
|
2051
|
+
}
|
|
2052
|
+
};
|
|
2053
|
+
}
|
|
2054
|
+
function versionBannerProcessorDeprecated(message, container) {
|
|
2055
|
+
return motdProcessor({
|
|
2056
|
+
enabled: true,
|
|
2057
|
+
container,
|
|
2058
|
+
message
|
|
2059
|
+
});
|
|
2060
|
+
}
|
|
2061
|
+
const versionBannerProcessor = util.deprecate(
|
|
2062
|
+
versionBannerProcessorDeprecated,
|
|
2063
|
+
"versionBannerProcessor() is deprecated, use motdProcessor() instead"
|
|
2064
|
+
);
|
|
2065
|
+
|
|
2024
2066
|
function themeSelectProcessor() {
|
|
2025
2067
|
return {
|
|
2026
2068
|
name: "theme-select-processor",
|
|
2027
2069
|
after: "generate-docs",
|
|
2028
2070
|
handler(context) {
|
|
2071
|
+
const sessionKey = "fkds-theme";
|
|
2072
|
+
const data = {
|
|
2073
|
+
defaultTheme: "exp",
|
|
2074
|
+
sessionKey
|
|
2075
|
+
};
|
|
2076
|
+
context.addTemplateBlock("head", "theme-render-blocker", {
|
|
2077
|
+
filename: "partials/theme-render-blocker.html",
|
|
2078
|
+
data
|
|
2079
|
+
});
|
|
2029
2080
|
context.addTemplateBlock("toolbar", "theme-select", {
|
|
2030
|
-
filename: "partials/theme-select.html"
|
|
2081
|
+
filename: "partials/theme-select.html",
|
|
2082
|
+
data
|
|
2031
2083
|
});
|
|
2032
2084
|
}
|
|
2033
2085
|
};
|
|
@@ -2162,19 +2214,6 @@ function versionProcessor(pkg, container, options) {
|
|
|
2162
2214
|
};
|
|
2163
2215
|
}
|
|
2164
2216
|
|
|
2165
|
-
function versionBannerProcessor(message, container) {
|
|
2166
|
-
return {
|
|
2167
|
-
name: "version-banner-processor",
|
|
2168
|
-
after: "generate-docs",
|
|
2169
|
-
handler(context) {
|
|
2170
|
-
context.addTemplateBlock(container, "version-banner", {
|
|
2171
|
-
filename: "partials/version-banner.html",
|
|
2172
|
-
data: { message }
|
|
2173
|
-
});
|
|
2174
|
-
}
|
|
2175
|
-
};
|
|
2176
|
-
}
|
|
2177
|
-
|
|
2178
2217
|
function generateIndex(entries) {
|
|
2179
2218
|
const index = {
|
|
2180
2219
|
terms: [],
|
|
@@ -2253,14 +2292,7 @@ function searchProcessor() {
|
|
|
2253
2292
|
}
|
|
2254
2293
|
});
|
|
2255
2294
|
context.addTemplateBlock("toolbar", "search-toolbar", {
|
|
2256
|
-
filename: "partials/search-toolbar.html"
|
|
2257
|
-
data: {
|
|
2258
|
-
rootUrl(doc) {
|
|
2259
|
-
const { fileInfo } = doc;
|
|
2260
|
-
const relative = path$1.relative(fileInfo.path, ".");
|
|
2261
|
-
return relative !== "" ? relative : ".";
|
|
2262
|
-
}
|
|
2263
|
-
}
|
|
2295
|
+
filename: "partials/search-toolbar.html"
|
|
2264
2296
|
});
|
|
2265
2297
|
context.addTemplateBlock("body:end", "search-dialog", {
|
|
2266
2298
|
filename: "partials/search-dialog.html"
|
|
@@ -2276,6 +2308,7 @@ exports.frontMatterFileReader = frontMatterFileReader;
|
|
|
2276
2308
|
exports.livereloadProcessor = livereloadProcessor;
|
|
2277
2309
|
exports.manifestProcessor = manifestProcessor;
|
|
2278
2310
|
exports.matomoProcessor = matomoProcessor;
|
|
2311
|
+
exports.motdProcessor = motdProcessor;
|
|
2279
2312
|
exports.navigationFileReader = navigationFileReader;
|
|
2280
2313
|
exports.searchProcessor = searchProcessor;
|
|
2281
2314
|
exports.selectableVersionProcessor = selectableVersionProcessor;
|
package/dist/markdown.js
CHANGED
|
@@ -1,20 +1,22 @@
|
|
|
1
1
|
'use strict';
|
|
2
2
|
|
|
3
|
-
var createMarkdownRenderer = require('./create-markdown-renderer-
|
|
4
|
-
require('./vendor-
|
|
5
|
-
require('node:path');
|
|
3
|
+
var createMarkdownRenderer = require('./create-markdown-renderer-Bo7YoF2w.js');
|
|
4
|
+
require('./vendor-xbC24N4h.js');
|
|
6
5
|
require('node:url');
|
|
6
|
+
require('node:path');
|
|
7
7
|
require('fs');
|
|
8
8
|
require('node:fs');
|
|
9
9
|
require('node:fs/promises');
|
|
10
|
-
require('events');
|
|
11
|
-
require('stream');
|
|
12
|
-
require('string_decoder');
|
|
10
|
+
require('node:events');
|
|
11
|
+
require('node:stream');
|
|
12
|
+
require('node:string_decoder');
|
|
13
13
|
require('constants');
|
|
14
|
+
require('stream');
|
|
14
15
|
require('util');
|
|
15
16
|
require('assert');
|
|
16
17
|
require('path');
|
|
17
18
|
require('readline');
|
|
19
|
+
require('events');
|
|
18
20
|
require('child_process');
|
|
19
21
|
require('node:buffer');
|
|
20
22
|
require('node:child_process');
|
package/dist/runtime.js
CHANGED
|
@@ -203810,6 +203810,7 @@ async function replaceContent(href) {
|
|
|
203810
203810
|
const body = await response.text();
|
|
203811
203811
|
const doc = parser20.parseFromString(body, "text/html");
|
|
203812
203812
|
const sidenav = doc.querySelector("#sidenav");
|
|
203813
|
+
const rootUrl = doc.documentElement.dataset.rootUrl;
|
|
203813
203814
|
const selector = response.ok && sidenav ? "main" : "body";
|
|
203814
203815
|
const header2 = doc.querySelector("header");
|
|
203815
203816
|
const headerTarget = document.querySelector("header");
|
|
@@ -203822,6 +203823,17 @@ async function replaceContent(href) {
|
|
|
203822
203823
|
cloneScripts(importedHeader, href);
|
|
203823
203824
|
headerTarget.replaceWith(importedHeader);
|
|
203824
203825
|
}
|
|
203826
|
+
const anchorSelector = "#sidenav li.link a";
|
|
203827
|
+
const anchorLinks = document.querySelectorAll(anchorSelector);
|
|
203828
|
+
for (const link2 of anchorLinks) {
|
|
203829
|
+
const { rel: rel2 } = link2;
|
|
203830
|
+
if (rel2 !== "external") {
|
|
203831
|
+
continue;
|
|
203832
|
+
}
|
|
203833
|
+
const path4 = link2.dataset.path ?? ".";
|
|
203834
|
+
link2.setAttribute("href", [rootUrl, path4].join("/"));
|
|
203835
|
+
}
|
|
203836
|
+
document.documentElement.dataset.rootUrl = rootUrl;
|
|
203825
203837
|
document.title = doc.title;
|
|
203826
203838
|
target.replaceWith(element2);
|
|
203827
203839
|
}
|
|
@@ -204678,7 +204690,6 @@ var results = document.querySelector("#search-results");
|
|
|
204678
204690
|
var index2 = null;
|
|
204679
204691
|
var searchTerm = "";
|
|
204680
204692
|
var active = 0;
|
|
204681
|
-
var rootUrl = button.dataset.rootUrl;
|
|
204682
204693
|
var uf = new uFuzzy({
|
|
204683
204694
|
intraIns: Infinity
|
|
204684
204695
|
});
|
|
@@ -204695,6 +204706,7 @@ function updateResults() {
|
|
|
204695
204706
|
const info3 = uf.info(idxs, index2.terms, searchTerm);
|
|
204696
204707
|
const order2 = uf.sort(info3, index2.terms, searchTerm);
|
|
204697
204708
|
active = 0;
|
|
204709
|
+
const rootUrl = document.documentElement.dataset.rootUrl ?? ".";
|
|
204698
204710
|
const ul = document.createElement("ul");
|
|
204699
204711
|
ul.classList.add("list");
|
|
204700
204712
|
for (let i2 = 0; i2 < order2.length; i2++) {
|