@forsakringskassan/docs-generator 2.14.2 → 2.14.4
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/README.md
CHANGED
|
@@ -107,9 +107,9 @@ export function setup(options: SetupOptions): void {
|
|
|
107
107
|
|
|
108
108
|
Three CSS files are provided:
|
|
109
109
|
|
|
110
|
-
-
|
|
111
|
-
-
|
|
112
|
-
-
|
|
110
|
+
- `@forsakringskassan/docs-generator/style/index.css` (aliased as `@forsakringskassan/docs-generator/style`)
|
|
111
|
+
- `@forsakringskassan/docs-generator/style/core.css`
|
|
112
|
+
- `@forsakringskassan/docs-generator/style/site.css`
|
|
113
113
|
|
|
114
114
|
`core` contains the necessary styling for components and elements and `site` contains the layout, typography etc required for a documentation site to work.
|
|
115
115
|
`index` is a combination of the two and should be used in most cases.
|
|
@@ -167,12 +167,12 @@ The link destination will always be relative to the current document.
|
|
|
167
167
|
For configured languages (default `html` and `vue`) code fences are run as a live example in the browser with an option to display the source code.
|
|
168
168
|
The following tags can be used:
|
|
169
169
|
|
|
170
|
-
-
|
|
171
|
-
-
|
|
172
|
-
-
|
|
173
|
-
-
|
|
174
|
-
-
|
|
175
|
-
-
|
|
170
|
+
- `borderless` - removes the border from the example.
|
|
171
|
+
- `fullscreen` - enable support for viewing the example in fullscreen.
|
|
172
|
+
- `static` - force code to be rendered without live preview (only syntax highlight).
|
|
173
|
+
- `live-example` - mark example as containing the `LiveExample` component.
|
|
174
|
+
- `nomarkup` - for live examples this hides the syntax highlighted code and only displays the result of the running code.
|
|
175
|
+
- `test-id=STRING` - Sets the `data-test` attribute.
|
|
176
176
|
|
|
177
177
|
`static` and `live` are used to manually set whenever the code should be run as a live example or not.
|
|
178
178
|
|
|
@@ -215,12 +215,12 @@ Set a status badge for a component.
|
|
|
215
215
|
|
|
216
216
|
The following statuses are recognized:
|
|
217
217
|
|
|
218
|
-
-
|
|
219
|
-
-
|
|
220
|
-
-
|
|
221
|
-
-
|
|
222
|
-
-
|
|
223
|
-
-
|
|
218
|
+
- `Produktionsklar`
|
|
219
|
+
- `Deprekerad`
|
|
220
|
+
- `Experimentell`
|
|
221
|
+
- `Preliminär`
|
|
222
|
+
- `Draft` (deprecated alias for `Preliminär`)
|
|
223
|
+
- `Beta` (deprecated alias for `Preliminär`)
|
|
224
224
|
|
|
225
225
|
#### `title`
|
|
226
226
|
|
|
@@ -524,7 +524,7 @@ function codePreview(options) {
|
|
|
524
524
|
tags: rawTags
|
|
525
525
|
});
|
|
526
526
|
const { tags } = example;
|
|
527
|
-
const hashContent = `${map?.[0]}:${map?.[1]}:${info}:${
|
|
527
|
+
const hashContent = `${map?.[0]}:${map?.[1]}:${info}:${source}`;
|
|
528
528
|
const fingerprint = getFingerprint(hashContent);
|
|
529
529
|
const transformedCode = transformCode(example.source, example.language);
|
|
530
530
|
const highlightedCode = replaceAtLink(
|
package/dist/index.js
CHANGED
|
@@ -6,7 +6,7 @@ var vendor = require('./vendor-Bb38Rlio.js');
|
|
|
6
6
|
var path$1 = require('node:path');
|
|
7
7
|
var require$$1 = require('crypto');
|
|
8
8
|
require('node:crypto');
|
|
9
|
-
var createMarkdownRenderer = require('./create-markdown-renderer-
|
|
9
|
+
var createMarkdownRenderer = require('./create-markdown-renderer-KS2pk3bP.js');
|
|
10
10
|
var node_child_process = require('node:child_process');
|
|
11
11
|
var util = require('node:util');
|
|
12
12
|
var vueDocgenApi = require('vue-docgen-api');
|
package/dist/markdown.js
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@forsakringskassan/docs-generator",
|
|
3
|
-
"version": "2.14.
|
|
3
|
+
"version": "2.14.4",
|
|
4
4
|
"description": "Documentation generator",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"documentation"
|
|
@@ -55,7 +55,7 @@
|
|
|
55
55
|
"dependencies": {
|
|
56
56
|
"livereload-js": "4.0.2",
|
|
57
57
|
"nunjucks": "3.2.4",
|
|
58
|
-
"piscina": "4.
|
|
58
|
+
"piscina": "4.8.0",
|
|
59
59
|
"vue-docgen-api": "4.79.2"
|
|
60
60
|
},
|
|
61
61
|
"peerDependencies": {
|