soliddoc 0.6.0-beta.36

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 OpenZeppelin.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,42 @@
+# `solidity-docgen`
+
+*solidity-docgen is a program that extracts documentation for a Solidity project.*
+
+The output is fully configurable through Handlebars templates, but the default templates should do a good job of displaying all of the information in the source code in Markdown format. The generated Markdown files can be used with a static site generator such as Vuepress, MkDocs, Jekyll (GitHub Pages), etc., in order to publish a documentation website.
+
+This is a newer version of the tool that has been rewritten and redesigned. Some more work is pending to ease the transition from the previous version and to help with usage and configuration.
+
+## Usage
+
+Install `solidity-docgen` from npm.
+
+### Hardhat
+
+Include the plugin in your Hardhat configuration.
+
+```diff
+ // hardhat.config.ts
++import 'solidity-docgen';
+
+ export default {
++  docgen: { ... }, // if necessary to customize config
+ };
+```
+
+Then run with `hardhat docgen`.
+
+### As a library
+
+```typescript
+import { docgen } from 'solidity-docgen';
+
+await docgen([{ output: solcOutput }], config);
+```
+
+`solcOutput` must be the standard JSON output of the compiler, with at least the `ast` output. There can be more than one.
+
+`config` is an optional object with the values as specified below.
+
+## Config
+
+See [`config.ts`](./src/config.ts) for the list of options and their documentation.

package/dist/common/helpers.d.ts

@@ -0,0 +1,9 @@
+import { VariableDeclaration } from "solidity-ast";
+export declare function trim(text: string): string | undefined;
+export declare function joinLines(text?: string): string | undefined;
+/**
+ * Format a variable as its type followed by its name, if available.
+ */
+export declare function formatVariable(v: VariableDeclaration): string;
+export declare const eq: (a: unknown, b: unknown) => boolean;
+//# sourceMappingURL=helpers.d.ts.map

package/dist/common/helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../src/common/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAEnD,wBAAgB,IAAI,CAAC,IAAI,EAAE,MAAM,sBAIhC;AAED,wBAAgB,SAAS,CAAC,IAAI,CAAC,EAAE,MAAM,sBAItC;AAED;;GAEG;AACH,wBAAgB,cAAc,CAAC,CAAC,EAAE,mBAAmB,GAAG,MAAM,CAE7D;AAED,eAAO,MAAM,EAAE,MAAO,OAAO,KAAK,OAAO,YAAY,CAAC"}

package/dist/common/helpers.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.eq = exports.formatVariable = exports.joinLines = exports.trim = void 0;
+function trim(text) {
+    if (typeof text === 'string') {
+        return text.trim();
+    }
+}
+exports.trim = trim;
+function joinLines(text) {
+    if (typeof text === 'string') {
+        return text.replace(/[\r\n]+/g, ' ');
+    }
+}
+exports.joinLines = joinLines;
+/**
+ * Format a variable as its type followed by its name, if available.
+ */
+function formatVariable(v) {
+    return [v.typeName?.typeDescriptions.typeString].concat(v.name || []).join(' ');
+}
+exports.formatVariable = formatVariable;
+const eq = (a, b) => a === b;
+exports.eq = eq;
+//# sourceMappingURL=helpers.js.map

package/dist/common/helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../src/common/helpers.ts"],"names":[],"mappings":";;;AAEA,SAAgB,IAAI,CAAC,IAAY;IAC/B,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;QAC5B,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC;KACpB;AACH,CAAC;AAJD,oBAIC;AAED,SAAgB,SAAS,CAAC,IAAa;IACrC,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;QAC5B,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;KACtC;AACH,CAAC;AAJD,8BAIC;AAED;;GAEG;AACH,SAAgB,cAAc,CAAC,CAAsB;IACnD,OAAO,CAAC,CAAC,CAAC,QAAQ,EAAE,gBAAgB,CAAC,UAAW,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACnF,CAAC;AAFD,wCAEC;AAEM,MAAM,EAAE,GAAG,CAAC,CAAU,EAAE,CAAU,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC;AAAzC,QAAA,EAAE,MAAuC"}

package/dist/common/properties.d.ts

@@ -0,0 +1,25 @@
+import { EnumDefinition, ErrorDefinition, EventDefinition, FunctionDefinition, ModifierDefinition, StructDefinition, UserDefinedValueTypeDefinition, VariableDeclaration } from 'solidity-ast';
+import { NatSpec } from '../utils/natspec';
+import { DocItemContext } from '../site';
+import { DocItem } from '../doc-item';
+type TypeDefinition = StructDefinition | EnumDefinition | UserDefinedValueTypeDefinition;
+export declare function type({ item }: DocItemContext): string;
+export declare function natspec({ item }: DocItemContext): NatSpec;
+export declare function name({ item }: DocItemContext, original?: unknown): string;
+export declare function fullName({ item, contract }: DocItemContext): string;
+export declare function signature({ item }: DocItemContext): string | undefined;
+interface Param extends VariableDeclaration {
+    type: string;
+    natspec?: string;
+}
+export declare function params({ item }: DocItemContext): Param[] | undefined;
+export declare function returns({ item }: DocItemContext): Param[] | undefined;
+export declare function items({ item }: DocItemContext): DocItem[] | undefined;
+export declare function functions({ item }: DocItemContext): FunctionDefinition[] | undefined;
+export declare function events({ item }: DocItemContext): EventDefinition[] | undefined;
+export declare function modifiers({ item }: DocItemContext): ModifierDefinition[] | undefined;
+export declare function errors({ item }: DocItemContext): ErrorDefinition[] | undefined;
+export declare function variables({ item }: DocItemContext): VariableDeclaration[] | undefined;
+export declare function types({ item }: DocItemContext): TypeDefinition[] | undefined;
+export {};
+//# sourceMappingURL=properties.d.ts.map

package/dist/common/properties.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"properties.d.ts","sourceRoot":"","sources":["../../src/common/properties.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,eAAe,EAAE,kBAAkB,EAAE,kBAAkB,EAAiB,gBAAgB,EAAE,8BAA8B,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAE9M,OAAO,EAAE,OAAO,EAAgB,MAAM,kBAAkB,CAAC;AACzD,OAAO,EAAE,cAAc,EAAoB,MAAM,SAAS,CAAC;AAE3D,OAAO,EAAE,OAAO,EAAgB,MAAM,aAAa,CAAC;AAKpD,KAAK,cAAc,GAAG,gBAAgB,GAAG,cAAc,GAAG,8BAA8B,CAAC;AAEzF,wBAAgB,IAAI,CAAC,EAAE,IAAI,EAAE,EAAE,cAAc,GAAG,MAAM,CAErD;AAED,wBAAgB,OAAO,CAAC,EAAE,IAAI,EAAE,EAAE,cAAc,GAAG,OAAO,CAEzD;AAED,wBAAgB,IAAI,CAAC,EAAE,IAAI,EAAE,EAAE,cAAc,EAAE,QAAQ,CAAC,EAAE,OAAO,GAAG,MAAM,CAMzE;AAED,wBAAgB,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,cAAc,GAAG,MAAM,CAMnE;AAED,wBAAgB,SAAS,CAAC,EAAE,IAAI,EAAE,EAAE,cAAc,GAAG,MAAM,GAAG,SAAS,CA4CtE;AAED,UAAU,KAAM,SAAQ,mBAAmB;IACzC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAUD,wBAAgB,MAAM,CAAC,EAAE,IAAI,EAAE,EAAE,cAAc,GAAG,KAAK,EAAE,GAAG,SAAS,CAIpE;AAED,wBAAgB,OAAO,CAAC,EAAE,IAAI,EAAE,EAAE,cAAc,GAAG,KAAK,EAAE,GAAG,SAAS,CAIrE;AAED,wBAAgB,KAAK,CAAC,EAAE,IAAI,EAAE,EAAE,cAAc,GAAG,OAAO,EAAE,GAAG,SAAS,CAIrE;AAED,wBAAgB,SAAS,CAAC,EAAE,IAAI,EAAE,EAAE,cAAc,GAAG,kBAAkB,EAAE,GAAG,SAAS,CAEpF;AAED,wBAAgB,MAAM,CAAC,EAAE,IAAI,EAAE,EAAE,cAAc,GAAG,eAAe,EAAE,GAAG,SAAS,CAE9E;AAED,wBAAgB,SAAS,CAAC,EAAE,IAAI,EAAE,EAAE,cAAc,GAAG,kBAAkB,EAAE,GAAG,SAAS,CAEpF;AAED,wBAAgB,MAAM,CAAC,EAAE,IAAI,EAAE,EAAE,cAAc,GAAG,eAAe,EAAE,GAAG,SAAS,CAE9E;AAED,wBAAgB,SAAS,CAAC,EAAE,IAAI,EAAE,EAAE,cAAc,GAAG,mBAAmB,EAAE,GAAG,SAAS,CAIrF;AAED,wBAAgB,KAAK,CAAC,EAAE,IAAI,EAAE,EAAE,cAAc,GAAG,cAAc,EAAE,GAAG,SAAS,CAE5E"}

package/dist/common/properties.js

@@ -0,0 +1,129 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.types = exports.variables = exports.errors = exports.modifiers = exports.events = exports.functions = exports.items = exports.returns = exports.params = exports.signature = exports.fullName = exports.name = exports.natspec = exports.type = void 0;
+const utils_1 = require("solidity-ast/utils");
+const natspec_1 = require("../utils/natspec");
+const site_1 = require("../site");
+const doc_item_1 = require("../doc-item");
+const helpers_1 = require("./helpers");
+const item_type_1 = require("../utils/item-type");
+function type({ item }) {
+    return (0, item_type_1.itemType)(item);
+}
+exports.type = type;
+function natspec({ item }) {
+    return (0, natspec_1.parseNatspec)(item);
+}
+exports.natspec = natspec;
+function name({ item }, original) {
+    if (item.nodeType === 'FunctionDefinition') {
+        return typeof (original) === 'string' && original !== '' ? original : item.kind;
+    }
+    else {
+        return original;
+    }
+}
+exports.name = name;
+function fullName({ item, contract }) {
+    if (contract) {
+        return `${contract.name}.${item.name}`;
+    }
+    else {
+        return `${item.name}`;
+    }
+}
+exports.fullName = fullName;
+function signature({ item }) {
+    switch (item.nodeType) {
+        case 'ContractDefinition':
+            return undefined;
+        case 'FunctionDefinition': {
+            const { kind, name } = item;
+            const params = item.parameters.parameters;
+            const returns = item.returnParameters.parameters;
+            const head = (kind === 'function' || kind === 'freeFunction') ? `function ${name}` : kind;
+            let res = [
+                `${head}(${params.map(helpers_1.formatVariable).join(', ')})`,
+                item.visibility,
+            ];
+            if (item.stateMutability !== 'nonpayable') {
+                res.push(item.stateMutability);
+            }
+            if (item.virtual) {
+                res.push('virtual');
+            }
+            if (returns.length > 0) {
+                res.push(`returns (${returns.map(helpers_1.formatVariable).join(', ')})`);
+            }
+            return res.join(' ');
+        }
+        case 'EventDefinition': {
+            const params = item.parameters.parameters;
+            return `event ${item.name}(${params.map(helpers_1.formatVariable).join(', ')})`;
+        }
+        case 'ErrorDefinition': {
+            const params = item.parameters.parameters;
+            return `error ${item.name}(${params.map(helpers_1.formatVariable).join(', ')})`;
+        }
+        case 'ModifierDefinition': {
+            const params = item.parameters.parameters;
+            return `modifier ${item.name}(${params.map(helpers_1.formatVariable).join(', ')})`;
+        }
+        case 'VariableDeclaration':
+            return (0, helpers_1.formatVariable)(item);
+    }
+}
+exports.signature = signature;
+;
+function getParams(params, natspec) {
+    return params.parameters.map((p, i) => ({
+        ...p,
+        type: p.typeDescriptions.typeString,
+        natspec: natspec?.find((q, j) => q.name === undefined ? i === j : p.name === q.name)?.description,
+    }));
+}
+function params({ item }) {
+    if ('parameters' in item) {
+        return getParams(item.parameters, natspec(item[site_1.DOC_ITEM_CONTEXT]).params);
+    }
+}
+exports.params = params;
+function returns({ item }) {
+    if ('returnParameters' in item) {
+        return getParams(item.returnParameters, natspec(item[site_1.DOC_ITEM_CONTEXT]).returns);
+    }
+}
+exports.returns = returns;
+function items({ item }) {
+    return (item.nodeType === 'ContractDefinition')
+        ? item.nodes.filter((0, utils_1.isNodeType)(doc_item_1.docItemTypes)).filter(n => !('visibility' in n) || n.visibility !== 'private')
+        : undefined;
+}
+exports.items = items;
+function functions({ item }) {
+    return [...(0, utils_1.findAll)('FunctionDefinition', item)].filter(f => f.visibility !== 'private');
+}
+exports.functions = functions;
+function events({ item }) {
+    return [...(0, utils_1.findAll)('EventDefinition', item)];
+}
+exports.events = events;
+function modifiers({ item }) {
+    return [...(0, utils_1.findAll)('ModifierDefinition', item)];
+}
+exports.modifiers = modifiers;
+function errors({ item }) {
+    return [...(0, utils_1.findAll)('ErrorDefinition', item)];
+}
+exports.errors = errors;
+function variables({ item }) {
+    return (item.nodeType === 'ContractDefinition')
+        ? item.nodes.filter((0, utils_1.isNodeType)('VariableDeclaration')).filter(v => v.stateVariable && v.visibility !== 'private')
+        : undefined;
+}
+exports.variables = variables;
+function types({ item }) {
+    return [...(0, utils_1.findAll)(['StructDefinition', 'EnumDefinition', 'UserDefinedValueTypeDefinition'], item)];
+}
+exports.types = types;
+//# sourceMappingURL=properties.js.map

package/dist/common/properties.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"properties.js","sourceRoot":"","sources":["../../src/common/properties.ts"],"names":[],"mappings":";;;AACA,8CAAyD;AACzD,8CAAyD;AACzD,kCAA2D;AAE3D,0CAAoD;AACpD,uCAA2C;AAE3C,kDAA8C;AAI9C,SAAgB,IAAI,CAAC,EAAE,IAAI,EAAkB;IAC3C,OAAO,IAAA,oBAAQ,EAAC,IAAI,CAAC,CAAC;AACxB,CAAC;AAFD,oBAEC;AAED,SAAgB,OAAO,CAAC,EAAE,IAAI,EAAkB;IAC9C,OAAO,IAAA,sBAAY,EAAC,IAAI,CAAC,CAAC;AAC5B,CAAC;AAFD,0BAEC;AAED,SAAgB,IAAI,CAAC,EAAE,IAAI,EAAkB,EAAE,QAAkB;IAC/D,IAAI,IAAI,CAAC,QAAQ,KAAK,oBAAoB,EAAE;QAC1C,OAAO,OAAM,CAAC,QAAQ,CAAC,KAAK,QAAQ,IAAI,QAAQ,KAAK,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;KAChF;SAAM;QACL,OAAO,QAAkB,CAAC;KAC3B;AACH,CAAC;AAND,oBAMC;AAED,SAAgB,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAkB;IACzD,IAAI,QAAQ,EAAE;QACZ,OAAO,GAAG,QAAQ,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;KACxC;SAAM;QACL,OAAO,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;KACvB;AACH,CAAC;AAND,4BAMC;AAED,SAAgB,SAAS,CAAC,EAAE,IAAI,EAAkB;IAChD,QAAQ,IAAI,CAAC,QAAQ,EAAE;QACrB,KAAK,oBAAoB;YACvB,OAAO,SAAS,CAAC;QAEnB,KAAK,oBAAoB,CAAC,CAAC;YACzB,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;YAC5B,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC;YAC1C,MAAM,OAAO,GAAG,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC;YACjD,MAAM,IAAI,GAAG,CAAC,IAAI,KAAK,UAAU,IAAI,IAAI,KAAK,cAAc,CAAC,CAAC,CAAC,CAAC,YAAY,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;YAC1F,IAAI,GAAG,GAAG;gBACR,GAAG,IAAI,IAAI,MAAM,CAAC,GAAG,CAAC,wBAAc,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG;gBACnD,IAAI,CAAC,UAAU;aAChB,CAAC;YACF,IAAI,IAAI,CAAC,eAAe,KAAK,YAAY,EAAE;gBACzC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;aAChC;YACD,IAAI,IAAI,CAAC,OAAO,EAAE;gBAChB,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;aACrB;YACD,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;gBACtB,GAAG,CAAC,IAAI,CAAC,YAAY,OAAO,CAAC,GAAG,CAAC,wBAAc,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;aACjE;YACD,OAAO,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SACtB;QAED,KAAK,iBAAiB,CAAC,CAAC;YACtB,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC;YAC1C,OAAO,SAAS,IAAI,CAAC,IAAI,IAAI,MAAM,CAAC,GAAG,CAAC,wBAAc,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;SACvE;QAED,KAAK,iBAAiB,CAAC,CAAC;YACtB,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC;YAC1C,OAAO,SAAS,IAAI,CAAC,IAAI,IAAI,MAAM,CAAC,GAAG,CAAC,wBAAc,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;SACvE;QAED,KAAK,oBAAoB,CAAC,CAAC;YACzB,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC;YAC1C,OAAO,YAAY,IAAI,CAAC,IAAI,IAAI,MAAM,CAAC,GAAG,CAAC,wBAAc,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;SAC1E;QAED,KAAK,qBAAqB;YACxB,OAAO,IAAA,wBAAc,EAAC,IAAI,CAAC,CAAC;KAC/B;AACH,CAAC;AA5CD,8BA4CC;AAKA,CAAC;AAEF,SAAS,SAAS,CAAC,MAAqB,EAAE,OAA+C;IACvF,OAAO,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;QACtC,GAAG,CAAC;QACJ,IAAI,EAAE,CAAC,CAAC,gBAAgB,CAAC,UAAW;QACpC,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,IAAI,CAAC,EAAE,WAAW;KAClG,CAAC,CAAC,CAAC;AACN,CAAC;AAED,SAAgB,MAAM,CAAC,EAAE,IAAI,EAAkB;IAC7C,IAAI,YAAY,IAAI,IAAI,EAAE;QACxB,OAAO,SAAS,CAAC,IAAI,CAAC,UAAU,EAAE,OAAO,CAAC,IAAI,CAAC,uBAAgB,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;KAC3E;AACH,CAAC;AAJD,wBAIC;AAED,SAAgB,OAAO,CAAC,EAAE,IAAI,EAAkB;IAC9C,IAAI,kBAAkB,IAAI,IAAI,EAAE;QAC9B,OAAO,SAAS,CAAC,IAAI,CAAC,gBAAgB,EAAE,OAAO,CAAC,IAAI,CAAC,uBAAgB,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;KAClF;AACH,CAAC;AAJD,0BAIC;AAED,SAAgB,KAAK,CAAC,EAAE,IAAI,EAAkB;IAC5C,OAAO,CAAC,IAAI,CAAC,QAAQ,KAAK,oBAAoB,CAAC;QAC7C,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAA,kBAAU,EAAC,uBAAY,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,YAAY,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,UAAU,KAAK,SAAS,CAAC;QAC7G,CAAC,CAAC,SAAS,CAAC;AAChB,CAAC;AAJD,sBAIC;AAED,SAAgB,SAAS,CAAC,EAAE,IAAI,EAAkB;IAChD,OAAO,CAAC,GAAG,IAAA,eAAO,EAAC,oBAAoB,EAAE,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,UAAU,KAAK,SAAS,CAAC,CAAC;AAC1F,CAAC;AAFD,8BAEC;AAED,SAAgB,MAAM,CAAC,EAAE,IAAI,EAAkB;IAC7C,OAAO,CAAC,GAAG,IAAA,eAAO,EAAC,iBAAiB,EAAE,IAAI,CAAC,CAAC,CAAC;AAC/C,CAAC;AAFD,wBAEC;AAED,SAAgB,SAAS,CAAC,EAAE,IAAI,EAAkB;IAChD,OAAO,CAAC,GAAG,IAAA,eAAO,EAAC,oBAAoB,EAAE,IAAI,CAAC,CAAC,CAAC;AAClD,CAAC;AAFD,8BAEC;AAED,SAAgB,MAAM,CAAC,EAAE,IAAI,EAAkB;IAC7C,OAAO,CAAC,GAAG,IAAA,eAAO,EAAC,iBAAiB,EAAE,IAAI,CAAC,CAAC,CAAC;AAC/C,CAAC;AAFD,wBAEC;AAED,SAAgB,SAAS,CAAC,EAAE,IAAI,EAAkB;IAChD,OAAO,CAAC,IAAI,CAAC,QAAQ,KAAK,oBAAoB,CAAC;QAC7C,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAA,kBAAU,EAAC,qBAAqB,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,aAAa,IAAI,CAAC,CAAC,UAAU,KAAK,SAAS,CAAC;QACjH,CAAC,CAAC,SAAS,CAAC;AAChB,CAAC;AAJD,8BAIC;AAED,SAAgB,KAAK,CAAC,EAAE,IAAI,EAAkB;IAC5C,OAAO,CAAC,GAAG,IAAA,eAAO,EAAC,CAAC,kBAAkB,EAAE,gBAAgB,EAAE,gCAAgC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC;AACtG,CAAC;AAFD,sBAEC"}

package/dist/config.d.ts

@@ -0,0 +1,59 @@
+import type { PageAssigner } from './site';
+export interface UserConfig {
+    /**
+     * The directory where rendered pages will be written.
+     * Defaults to 'docs'.
+     */
+    outputDir?: string;
+    /**
+     * A directory of custom templates that should take precedence over the
+     * theme's templates.
+     */
+    templates?: string;
+    /**
+     * The name of the built-in templates that will be used by default.
+     * Defaults to 'markdown'.
+     */
+    theme?: string;
+    /**
+     * The way documentable items (contracts, functions, custom errors, etc.)
+     * will be organized in pages. Built in options are:
+     * - 'single': all items in one page
+     * - 'items': one page per item
+     * - 'files': one page per input Solidity file
+     * More customization is possible by defining a function that returns a page
+     * path given the AST node for the item and the source unit where it is
+     * defined.
+     * Defaults to 'single'.
+     */
+    pages?: 'single' | 'items' | 'files' | PageAssigner;
+    /**
+     * An array of sources subdirectories that should be excluded from
+     * documentation, relative to the contract sources directory.
+     */
+    exclude?: string[];
+    /**
+     * Clean up the output by collapsing 3 or more contiguous newlines into only 2.
+     * Enabled by default.
+     */
+    collapseNewlines?: boolean;
+    /**
+     * The extension for generated pages.
+     * Defaults to '.md'.
+     */
+    pageExtension?: string;
+}
+export interface Config extends UserConfig {
+    /**
+     * The root directory relative to which 'outputDir', 'sourcesDir', and
+     * 'templates' are specified. Defaults to the working directory.
+     */
+    root?: string;
+    /**
+     * The Solidity sources directory.
+     */
+    sourcesDir?: string;
+}
+export type FullConfig = Required<Config>;
+export declare const defaults: Omit<FullConfig, 'templates'>;
+//# sourceMappingURL=config.d.ts.map

package/dist/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAiB,MAAM,QAAQ,CAAC;AAE1D,MAAM,WAAW,UAAU;IACzB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;;;;;;OAUG;IACH,KAAK,CAAC,EAAE,QAAQ,GAAG,OAAO,GAAG,OAAO,GAAG,YAAY,CAAC;IAEpD;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IAEnB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAMD,MAAM,WAAW,MAAO,SAAQ,UAAU;IACxC;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,MAAM,UAAU,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC;AAE1C,eAAO,MAAM,QAAQ,EAAE,IAAI,CAAC,UAAU,EAAE,WAAW,CASlD,CAAC"}

package/dist/config.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaults = void 0;
+exports.defaults = {
+    root: process.cwd(),
+    sourcesDir: 'contracts',
+    outputDir: 'docs',
+    pages: 'single',
+    exclude: [],
+    theme: 'markdown',
+    collapseNewlines: true,
+    pageExtension: '.md',
+};
+//# sourceMappingURL=config.js.map

package/dist/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":";;;AA0Ea,QAAA,QAAQ,GAAkC;IACrD,IAAI,EAAE,OAAO,CAAC,GAAG,EAAE;IACnB,UAAU,EAAE,WAAW;IACvB,SAAS,EAAE,MAAM;IACjB,KAAK,EAAE,QAAQ;IACf,OAAO,EAAE,EAAE;IACX,KAAK,EAAE,UAAU;IACjB,gBAAgB,EAAE,IAAI;IACtB,aAAa,EAAE,KAAK;CACrB,CAAC"}

package/dist/doc-item.d.ts

@@ -0,0 +1,6 @@
+import { ContractDefinition, ImportDirective, PragmaDirective, SourceUnit, UsingForDirective } from "solidity-ast";
+import { Node } from "solidity-ast/node";
+export type DocItem = Exclude<SourceUnit['nodes'][number] | ContractDefinition['nodes'][number], ImportDirective | PragmaDirective | UsingForDirective>;
+export declare const docItemTypes: readonly ["ContractDefinition", "EnumDefinition", "ErrorDefinition", "EventDefinition", "FunctionDefinition", "ModifierDefinition", "StructDefinition", "UserDefinedValueTypeDefinition", "VariableDeclaration"];
+export declare function isDocItem(node: Node): node is DocItem;
+//# sourceMappingURL=doc-item.d.ts.map

package/dist/doc-item.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"doc-item.d.ts","sourceRoot":"","sources":["../src/doc-item.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,eAAe,EAAE,eAAe,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AACnH,OAAO,EAAE,IAAI,EAAyB,MAAM,mBAAmB,CAAC;AAGhE,MAAM,MAAM,OAAO,GAAG,OAAO,CAC3B,UAAU,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,EACjE,eAAe,GAAG,eAAe,GAAG,iBAAiB,CACtD,CAAC;AAEF,eAAO,MAAM,YAAY,kNAUf,CAAC;AAKX,wBAAgB,SAAS,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,IAAI,OAAO,CAErD"}

package/dist/doc-item.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isDocItem = exports.docItemTypes = void 0;
+exports.docItemTypes = [
+    'ContractDefinition',
+    'EnumDefinition',
+    'ErrorDefinition',
+    'EventDefinition',
+    'FunctionDefinition',
+    'ModifierDefinition',
+    'StructDefinition',
+    'UserDefinedValueTypeDefinition',
+    'VariableDeclaration',
+];
+// Make sure at compile time that docItemTypes contains exactly the node types of DocItem.
+const _ = true;
+function isDocItem(node) {
+    return exports.docItemTypes.includes(node.nodeType);
+}
+exports.isDocItem = isDocItem;
+//# sourceMappingURL=doc-item.js.map

package/dist/doc-item.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"doc-item.js","sourceRoot":"","sources":["../src/doc-item.ts"],"names":[],"mappings":";;;AASa,QAAA,YAAY,GAAG;IAC1B,oBAAoB;IACpB,gBAAgB;IAChB,iBAAiB;IACjB,iBAAiB;IACjB,oBAAoB;IACpB,oBAAoB;IACpB,kBAAkB;IAClB,gCAAgC;IAChC,qBAAqB;CACb,CAAC;AAEX,0FAA0F;AAC1F,MAAM,CAAC,GAAkE,IAAI,CAAC;AAE9E,SAAgB,SAAS,CAAC,IAAU;IAClC,OAAQ,oBAAkC,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;AACrE,CAAC;AAFD,8BAEC"}

package/dist/hardhat/index.d.ts

@@ -0,0 +1,2 @@
+import './type-extensions';
+//# sourceMappingURL=index.d.ts.map

package/dist/hardhat/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/hardhat/index.ts"],"names":[],"mappings":"AAIA,OAAO,mBAAmB,CAAC"}

package/dist/hardhat/index.js

@@ -0,0 +1,50 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const config_1 = require("hardhat/config");
+require("./type-extensions");
+(0, config_1.extendConfig)((config, userConfig) => {
+    const path = require('path');
+    config.docgen ?? (config.docgen = {});
+    config.docgen.root = config.paths.root;
+    config.docgen.sourcesDir = path
+        .relative(config.paths.root, config.paths.sources)
+        .split(path.sep)
+        .join(path.posix.sep);
+});
+(0, config_1.task)('docgen', async (_, hre) => {
+    await hre.run('compile');
+    const { promises: fs } = await Promise.resolve().then(() => __importStar(require('fs')));
+    const { main } = await Promise.resolve().then(() => __importStar(require('../main')));
+    const buildInfoPaths = await hre.artifacts.getBuildInfoPaths();
+    const builds = await Promise.all(buildInfoPaths.map(async (p) => ({
+        mtime: (await fs.stat(p)).mtimeMs,
+        data: JSON.parse(await fs.readFile(p, 'utf8')),
+    })));
+    // Sort most recently modified first
+    builds.sort((a, b) => b.mtime - a.mtime);
+    await main(builds.map(b => b.data), hre.config.docgen);
+});
+//# sourceMappingURL=index.js.map

package/dist/hardhat/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/hardhat/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AAAA,2CAAoD;AAIpD,6BAA2B;AAE3B,IAAA,qBAAY,EAAC,CAAC,MAAM,EAAE,UAAU,EAAE,EAAE;IAClC,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAA0B,CAAC;IACtD,MAAM,CAAC,MAAM,KAAb,MAAM,CAAC,MAAM,GAAK,EAAE,EAAC;IACrB,MAAM,CAAC,MAAM,CAAC,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC;IACvC,MAAM,CAAC,MAAM,CAAC,UAAU,GAAG,IAAI;SAC5B,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC;SACjD,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC;SACf,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;AAC1B,CAAC,CAAC,CAAC;AAEH,IAAA,aAAI,EAAC,QAAQ,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,EAAE,EAAE;IAC9B,MAAM,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IAEzB,MAAM,EAAE,QAAQ,EAAE,EAAE,EAAE,GAAG,wDAAa,IAAI,GAAC,CAAC;IAC5C,MAAM,EAAE,IAAI,EAAE,GAAG,wDAAa,SAAS,GAAC,CAAC;IAEzC,MAAM,cAAc,GAAG,MAAM,GAAG,CAAC,SAAS,CAAC,iBAAiB,EAAE,CAAC;IAC/D,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,GAAG,CAC9B,cAAc,CAAC,GAAG,CAAC,KAAK,EAAC,CAAC,EAAC,EAAE,CAAC,CAAC;QAC7B,KAAK,EAAE,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO;QACjC,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAC,CAAc;KAC5D,CAAC,CAAC,CACJ,CAAC;IAEF,oCAAoC;IACpC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC;IAEzC,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;AACzD,CAAC,CAAC,CAAC"}

package/dist/hardhat/type-extensions.d.ts

@@ -0,0 +1,12 @@
+import "hardhat/types/config";
+import "hardhat/types/runtime";
+import type { Config, UserConfig } from '../config';
+declare module "hardhat/types/config" {
+    interface HardhatUserConfig {
+        docgen?: UserConfig;
+    }
+    interface HardhatConfig {
+        docgen: Config;
+    }
+}
+//# sourceMappingURL=type-extensions.d.ts.map

package/dist/hardhat/type-extensions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"type-extensions.d.ts","sourceRoot":"","sources":["../../src/hardhat/type-extensions.ts"],"names":[],"mappings":"AAAA,OAAO,sBAAsB,CAAC;AAC9B,OAAO,uBAAuB,CAAC;AAE/B,OAAO,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAEpD,OAAO,QAAQ,sBAAsB,CAAC;IACpC,UAAiB,iBAAiB;QAChC,MAAM,CAAC,EAAE,UAAU,CAAC;KACrB;IAED,UAAiB,aAAa;QAC5B,MAAM,EAAE,MAAM,CAAC;KAChB;CACF"}

package/dist/hardhat/type-extensions.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+require("hardhat/types/config");
+require("hardhat/types/runtime");
+//# sourceMappingURL=type-extensions.js.map

package/dist/hardhat/type-extensions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"type-extensions.js","sourceRoot":"","sources":["../../src/hardhat/type-extensions.ts"],"names":[],"mappings":";;AAAA,gCAA8B;AAC9B,iCAA+B"}

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export { main as docgen } from './main';
+export { docItemTypes } from './doc-item';
+export { DocItemWithContext } from './site';
+import './hardhat/type-extensions';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,IAAI,MAAM,EAAE,MAAM,QAAQ,CAAC;AACxC,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAC1C,OAAO,EAAE,kBAAkB,EAAE,MAAM,QAAQ,CAAC;AAE5C,OAAO,2BAA2B,CAAC"}

package/dist/index.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.docItemTypes = exports.docgen = void 0;
+var main_1 = require("./main");
+Object.defineProperty(exports, "docgen", { enumerable: true, get: function () { return main_1.main; } });
+var doc_item_1 = require("./doc-item");
+Object.defineProperty(exports, "docItemTypes", { enumerable: true, get: function () { return doc_item_1.docItemTypes; } });
+require("./hardhat/type-extensions");
+if ('extendConfig' in global && 'task' in global) {
+    // Assume Hardhat.
+    require('./hardhat');
+}
+// We ask Node.js not to cache this file.
+delete require.cache[__filename];
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,+BAAwC;AAA/B,8FAAA,IAAI,OAAU;AACvB,uCAA0C;AAAjC,wGAAA,YAAY,OAAA;AAGrB,qCAAmC;AAEnC,IAAI,cAAc,IAAI,MAAM,IAAI,MAAM,IAAI,MAAM,EAAE;IAChD,kBAAkB;IAClB,OAAO,CAAC,WAAW,CAAC,CAAC;CACtB;AAED,yCAAyC;AACzC,OAAO,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC"}

package/dist/main.d.ts

@@ -0,0 +1,9 @@
+import { Build } from './site';
+import { Config } from './config';
+/**
+ * Given a set of builds (i.e. solc outputs) and a user configuration, this
+ * function builds the site and renders it, writing all pages to the output
+ * directory.
+ */
+export declare function main(builds: Build[], userConfig?: Config): Promise<void>;
+//# sourceMappingURL=main.d.ts.map

package/dist/main.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,EAAa,MAAM,QAAQ,CAAC;AAE1C,OAAO,EAAE,MAAM,EAAY,MAAM,UAAU,CAAC;AAG5C;;;;GAIG;AACH,wBAAsB,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAY9E"}

package/dist/main.js

@@ -0,0 +1,30 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.main = void 0;
+const path_1 = __importDefault(require("path"));
+const fs_1 = require("fs");
+const render_1 = require("./render");
+const site_1 = require("./site");
+const config_1 = require("./config");
+const templates_1 = require("./templates");
+/**
+ * Given a set of builds (i.e. solc outputs) and a user configuration, this
+ * function builds the site and renders it, writing all pages to the output
+ * directory.
+ */
+async function main(builds, userConfig) {
+    const config = { ...config_1.defaults, ...userConfig };
+    const templates = await (0, templates_1.loadTemplates)(config.theme, config.root, config.templates);
+    const site = (0, site_1.buildSite)(builds, config, templates.properties ?? {});
+    const renderedSite = (0, render_1.render)(site, templates, config.collapseNewlines);
+    for (const { id, contents } of renderedSite) {
+        const outputFile = path_1.default.resolve(config.root, config.outputDir, id);
+        await fs_1.promises.mkdir(path_1.default.dirname(outputFile), { recursive: true });
+        await fs_1.promises.writeFile(outputFile, contents);
+    }
+}
+exports.main = main;
+//# sourceMappingURL=main.js.map

package/dist/main.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"main.js","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":";;;;;;AAAA,gDAAwB;AACxB,2BAAoC;AACpC,qCAAkC;AAClC,iCAA0C;AAE1C,qCAA4C;AAC5C,2CAA4C;AAE5C;;;;GAIG;AACI,KAAK,UAAU,IAAI,CAAC,MAAe,EAAE,UAAmB;IAC7D,MAAM,MAAM,GAAG,EAAE,GAAG,iBAAQ,EAAE,GAAG,UAAU,EAAE,CAAC;IAE9C,MAAM,SAAS,GAAG,MAAM,IAAA,yBAAa,EAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC;IACnF,MAAM,IAAI,GAAG,IAAA,gBAAS,EAAC,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,UAAU,IAAI,EAAE,CAAC,CAAC;IACnE,MAAM,YAAY,GAAG,IAAA,eAAM,EAAC,IAAI,EAAE,SAAS,EAAE,MAAM,CAAC,gBAAgB,CAAC,CAAC;IAEtE,KAAK,MAAM,EAAE,EAAE,EAAE,QAAQ,EAAE,IAAI,YAAY,EAAE;QAC3C,MAAM,UAAU,GAAG,cAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;QACnE,MAAM,aAAE,CAAC,KAAK,CAAC,cAAI,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAC9D,MAAM,aAAE,CAAC,SAAS,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;KAC1C;AACH,CAAC;AAZD,oBAYC"}

package/dist/render.d.ts

@@ -0,0 +1,9 @@
+import { Site, DocItemWithContext } from './site';
+import { Templates } from './templates';
+export interface RenderedPage {
+    id: string;
+    contents: string;
+}
+export declare function render(site: Site, templates: Templates, collapseNewlines?: boolean): RenderedPage[];
+export declare const itemPartialName: (item: DocItemWithContext) => string;
+//# sourceMappingURL=render.d.ts.map

package/dist/render.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"render.d.ts","sourceRoot":"","sources":["../src/render.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,EAAQ,kBAAkB,EAAoB,MAAM,QAAQ,CAAC;AAC1E,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAIxC,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;CAClB;AAQD,wBAAgB,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,SAAS,EAAE,gBAAgB,CAAC,EAAE,OAAO,GAAG,YAAY,EAAE,CAcnG;AAED,eAAO,MAAM,eAAe,SAAU,kBAAkB,WAAoD,CAAC"}