@forsakringskassan/docs-generator 2.42.0 → 2.43.0

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.
@@ -90,8 +90,13 @@ export declare interface DocumentPartial {
90
90
  name: string;
91
91
  /** alternative names this document can be referenced by */
92
92
  alias: string[];
93
- /** content of this document */
94
- body: string | ((tags: string[]) => string);
93
+ /**
94
+ * Content of this document
95
+ *
96
+ * @param tags - List of tags given when including this partial.
97
+ * @param reference - Reference used when importing this partial.
98
+ */
99
+ body: string | ((tags: string[], reference: DocumentPartialReference) => string);
95
100
  /** format of body */
96
101
  format: "markdown" | "html" | "json";
97
102
  fileInfo: {
@@ -100,6 +105,18 @@ export declare interface DocumentPartial {
100
105
  };
101
106
  }
102
107
 
108
+ /**
109
+ * Reference used when including a partial.
110
+ *
111
+ * @public
112
+ */
113
+ export declare interface DocumentPartialReference {
114
+ /** the type of identifier used to include this partial */
115
+ kind: "id" | "name" | "alias";
116
+ /** the identifier used to include this partial */
117
+ reference: string;
118
+ }
119
+
103
120
  /**
104
121
  * Represents an example needing compilation.
105
122
  *
package/dist/markdown.mjs CHANGED
@@ -2,8 +2,8 @@ import { createRequire as $createRequire } from "node:module";
2
2
 
3
3
  const require = $createRequire(import.meta.url);
4
4
 
5
- export { S as SoftError, c as createMarkdownRenderer } from './create-markdown-renderer-DX0B9T-x.mjs';
6
- import './vendor-BoRn-ubH.mjs';
5
+ export { S as SoftError, c as createMarkdownRenderer } from './create-markdown-renderer-CO5Te-tH.mjs';
6
+ import './vendor-BImorfXU.mjs';
7
7
  import 'node:url';
8
8
  import 'node:path';
9
9
  import 'fs';