soliddoc 0.6.0-beta.36

package/dist/render.js

@@ -0,0 +1,66 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.itemPartialName = exports.render = void 0;
+const handlebars_1 = __importDefault(require("handlebars"));
+const item_type_1 = require("./utils/item-type");
+const fs_1 = __importDefault(require("fs"));
+function render(site, templates, collapseNewlines) {
+    const renderPage = buildRenderer(templates);
+    const renderedPages = [];
+    for (const page of site.pages) {
+        let contents = renderPage(page, { data: { site } });
+        if (collapseNewlines) {
+            contents = contents.replace(/\n{3,}/g, '\n\n');
+        }
+        renderedPages.push({
+            id: page.id,
+            contents,
+        });
+    }
+    return renderedPages;
+}
+exports.render = render;
+const itemPartialName = (item) => (0, item_type_1.itemType)(item).replace(/ /g, '-').toLowerCase();
+exports.itemPartialName = itemPartialName;
+function itemPartial(item, options) {
+    if (!item.__item_context) {
+        throw new Error(`Partial 'item' used in unsupported context (not a doc item)`);
+    }
+    const partial = options?.partials?.[(0, exports.itemPartialName)(item)];
+    if (!partial) {
+        throw new Error(`Missing partial '${(0, exports.itemPartialName)(item)}'`);
+    }
+    return partial(item, options);
+}
+function readmeHelper(H, path, opts) {
+    const items = opts.data.root.items;
+    const renderedItems = Object.fromEntries(items.map(item => [
+        item.name,
+        new H.SafeString(H.compile('{{>item}}')(item, opts)),
+    ]));
+    return new H.SafeString(H.compile(fs_1.default.readFileSync(path, 'utf8'))(renderedItems, opts));
+}
+function buildRenderer(templates) {
+    const pageTemplate = templates.partials?.page;
+    if (pageTemplate === undefined) {
+        throw new Error(`Missing 'page' template`);
+    }
+    const H = handlebars_1.default.create();
+    for (const [name, getBody] of Object.entries(templates.partials ?? {})) {
+        let partial;
+        H.registerPartial(name, (...args) => {
+            partial ?? (partial = H.compile(getBody()));
+            return partial(...args);
+        });
+    }
+    H.registerHelper('readme', (path, opts) => readmeHelper(H, path, opts));
+    for (const [name, fn] of Object.entries(templates.helpers ?? {})) {
+        H.registerHelper(name, fn);
+    }
+    H.registerPartial('item', itemPartial);
+    return H.compile('{{>page}}');
+}
+//# sourceMappingURL=render.js.map

package/dist/render.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"render.js","sourceRoot":"","sources":["../src/render.ts"],"names":[],"mappings":";;;;;;AAAA,4DAAwD;AAGxD,iDAA6C;AAC7C,4CAAoB;AAapB,SAAgB,MAAM,CAAC,IAAU,EAAE,SAAoB,EAAE,gBAA0B;IACjF,MAAM,UAAU,GAAG,aAAa,CAAC,SAAS,CAAC,CAAC;IAC5C,MAAM,aAAa,GAAmB,EAAE,CAAC;IACzC,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE;QAC7B,IAAI,QAAQ,GAAG,UAAU,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;QACpD,IAAI,gBAAgB,EAAE;YACpB,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;SAChD;QACD,aAAa,CAAC,IAAI,CAAC;YACjB,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,QAAQ;SACT,CAAC,CAAC;KACJ;IACD,OAAO,aAAa,CAAC;AACvB,CAAC;AAdD,wBAcC;AAEM,MAAM,eAAe,GAAG,CAAC,IAAwB,EAAE,EAAE,CAAC,IAAA,oBAAQ,EAAC,IAAI,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,WAAW,EAAE,CAAC;AAAhG,QAAA,eAAe,mBAAiF;AAE7G,SAAS,WAAW,CAAC,IAAwB,EAAE,OAAwB;IACrE,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE;QACxB,MAAM,IAAI,KAAK,CAAC,6DAA6D,CAAC,CAAC;KAChF;IACD,MAAM,OAAO,GAAG,OAAO,EAAE,QAAQ,EAAE,CAAC,IAAA,uBAAe,EAAC,IAAI,CAAC,CAAC,CAAC;IAC3D,IAAI,CAAC,OAAO,EAAE;QACZ,MAAM,IAAI,KAAK,CAAC,oBAAoB,IAAA,uBAAe,EAAC,IAAI,CAAC,GAAG,CAAC,CAAC;KAC/D;IACD,OAAO,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;AAChC,CAAC;AAED,SAAS,YAAY,CAAC,CAAoB,EAAE,IAAY,EAAE,IAAoB;IAC5E,MAAM,KAAK,GAAyB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC;IACzD,MAAM,aAAa,GAAG,MAAM,CAAC,WAAW,CACtC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;QAChB,IAAI,CAAC,IAAI;QACT,IAAI,CAAC,CAAC,UAAU,CACd,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,CACnC;KACF,CAAC,CACH,CAAC;IACF,OAAO,IAAI,CAAC,CAAC,UAAU,CACrB,CAAC,CAAC,OAAO,CAAC,YAAE,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,aAAa,EAAE,IAAI,CAAC,CAC9D,CAAC;AACJ,CAAC;AAED,SAAS,aAAa,CAAC,SAAoB;IACzC,MAAM,YAAY,GAAG,SAAS,CAAC,QAAQ,EAAE,IAAI,CAAC;IAC9C,IAAI,YAAY,KAAK,SAAS,EAAE;QAC9B,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;KAC5C;IAED,MAAM,CAAC,GAAG,oBAAU,CAAC,MAAM,EAAE,CAAC;IAE9B,KAAK,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,QAAQ,IAAI,EAAE,CAAC,EAAE;QACtE,IAAI,OAA+C,CAAC;QACpD,CAAC,CAAC,eAAe,CAAC,IAAI,EAAE,CAAC,GAAG,IAAI,EAAE,EAAE;YAClC,OAAO,KAAP,OAAO,GAAK,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,EAAC;YACjC,OAAO,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC;QAC1B,CAAC,CAAC,CAAC;KACJ;IAED,CAAC,CAAC,cAAc,CAAC,QAAQ,EAAE,CAAC,IAAY,EAAE,IAAoB,EAAE,EAAE,CAAC,YAAY,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;IAEhG,KAAK,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,OAAO,IAAI,EAAE,CAAC,EAAE;QAChE,CAAC,CAAC,cAAc,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;KAC5B;IAED,CAAC,CAAC,eAAe,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IAEvC,OAAO,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;AAChC,CAAC"}

package/dist/render.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=render.test.d.ts.map

package/dist/render.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"render.test.d.ts","sourceRoot":"","sources":["../src/render.test.ts"],"names":[],"mappings":""}

package/dist/render.test.js

@@ -0,0 +1,42 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const test_1 = __importDefault(require("./utils/test"));
+const path_1 = __importDefault(require("path"));
+const site_1 = require("./site");
+const render_1 = require("./render");
+/**
+ * @param contracts The name of the Solidity file whose contents should be considered.
+ */
+function testRender(title, file, spec, expected) {
+    const id = 'index.md';
+    const cfg = {
+        sourcesDir: 'test-contracts',
+        exclude: [],
+        pageExtension: '.md',
+        pages: (_, f) => path_1.default.parse(f.absolutePath).name === file ? id : undefined,
+    };
+    (0, test_1.default)(title, t => {
+        const site = (0, site_1.buildSite)(t.context.build, cfg);
+        const rendered = (0, render_1.render)(site, spec, spec.collapseNewlines);
+        t.is(rendered.length, 1);
+        t.is(rendered[0].contents, expected);
+    });
+}
+testRender('static page', 'S08_AB', { partials: { page: () => 'a page' } }, 'a page');
+testRender('items', 'S08_AB', { partials: { page: () => '{{#each items}}{{name}}, {{/each}}' } }, 'A, B, ');
+testRender('partials', 'S08_AB', {
+    partials: {
+        page: () => '{{#each items}}{{>part}}, {{/each}}',
+        part: () => '{{name}}',
+    },
+}, 'A, B, ');
+testRender('item partial', 'S08_AB', {
+    partials: {
+        page: () => '{{#each items}}{{>item}}, {{/each}}',
+        contract: () => '{{name}}',
+    },
+}, 'A, B, ');
+//# sourceMappingURL=render.test.js.map

package/dist/render.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"render.test.js","sourceRoot":"","sources":["../src/render.test.ts"],"names":[],"mappings":";;;;;AAAA,wDAAgC;AAChC,gDAAwB;AACxB,iCAA8D;AAC9D,qCAAmD;AAQnD;;GAEG;AACH,SAAS,UAAU,CAAC,KAAa,EAAE,IAAY,EAAE,IAAc,EAAE,QAAgB;IAC/E,MAAM,EAAE,GAAG,UAAU,CAAC;IACtB,MAAM,GAAG,GAAe;QACtB,UAAU,EAAE,gBAAgB;QAC5B,OAAO,EAAE,EAAE;QACX,aAAa,EAAE,KAAK;QACpB,KAAK,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,cAAI,CAAC,KAAK,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS;KAC3E,CAAC;IAEF,IAAA,cAAI,EAAC,KAAK,EAAE,CAAC,CAAC,EAAE;QACd,MAAM,IAAI,GAAG,IAAA,gBAAS,EAAC,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;QAC7C,MAAM,QAAQ,GAAG,IAAA,eAAM,EAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAC3D,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QACzB,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAE,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IACxC,CAAC,CAAC,CAAC;AACL,CAAC;AAED,UAAU,CAAC,aAAa,EACtB,QAAQ,EACR,EAAE,QAAQ,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,QAAQ,EAAE,EAAE,EACtC,QAAQ,CACT,CAAC;AAEF,UAAU,CAAC,OAAO,EAChB,QAAQ,EACR,EAAE,QAAQ,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,oCAAoC,EAAE,EAAE,EAClE,QAAQ,CACT,CAAC;AAEF,UAAU,CAAC,UAAU,EACnB,QAAQ,EACR;IACE,QAAQ,EAAE;QACR,IAAI,EAAE,GAAG,EAAE,CAAC,qCAAqC;QACjD,IAAI,EAAE,GAAG,EAAE,CAAC,UAAU;KACvB;CACF,EACD,QAAQ,CACT,CAAC;AAEF,UAAU,CAAC,cAAc,EACvB,QAAQ,EACR;IACE,QAAQ,EAAE;QACR,IAAI,EAAE,GAAG,EAAE,CAAC,qCAAqC;QACjD,QAAQ,EAAE,GAAG,EAAE,CAAC,UAAU;KAC3B;CACF,EACD,QAAQ,CACT,CAAC"}

package/dist/site.d.ts

@@ -0,0 +1,42 @@
+import { ContractDefinition, SourceUnit } from 'solidity-ast';
+import { SolcOutput, SolcInput } from 'solidity-ast/solc';
+import { ASTDereferencer, SrcDecoder } from 'solidity-ast/utils';
+import { FullConfig } from './config';
+import { DocItem } from './doc-item';
+import { Properties } from './templates';
+export interface Build {
+    input: SolcInput;
+    output: SolcOutput;
+}
+export interface BuildContext extends Build {
+    deref: ASTDereferencer;
+    decodeSrc: SrcDecoder;
+}
+export type SiteConfig = Pick<FullConfig, 'pages' | 'exclude' | 'sourcesDir' | 'pageExtension'>;
+export type PageStructure = SiteConfig['pages'];
+export type PageAssigner = ((item: DocItem, file: SourceUnit, config: SiteConfig) => string | undefined);
+export declare const pageAssigner: Record<PageStructure & string, PageAssigner>;
+export interface Site {
+    items: DocItemWithContext[];
+    pages: Page[];
+}
+export interface Page {
+    id: string;
+    items: DocItemWithContext[];
+}
+export declare const DOC_ITEM_CONTEXT: "__item_context";
+export type DocItemWithContext = DocItem & {
+    [DOC_ITEM_CONTEXT]: DocItemContext;
+};
+export interface DocItemContext {
+    page?: string;
+    item: DocItemWithContext;
+    contract?: ContractDefinition;
+    file: DocItemContextFile;
+    build: BuildContext;
+}
+export interface DocItemContextFile extends SourceUnit {
+    relativePath: string;
+}
+export declare function buildSite(builds: Build[], siteConfig: SiteConfig, properties?: Properties): Site;
+//# sourceMappingURL=site.d.ts.map

package/dist/site.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"site.d.ts","sourceRoot":"","sources":["../src/site.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC9D,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAC1D,OAAO,EAAmB,eAAe,EAAmC,UAAU,EAAE,MAAM,oBAAoB,CAAC;AACnH,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AACtC,OAAO,EAAE,OAAO,EAA2B,MAAM,YAAY,CAAC;AAC9D,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAMzC,MAAM,WAAW,KAAK;IACpB,KAAK,EAAE,SAAS,CAAC;IACjB,MAAM,EAAE,UAAU,CAAC;CACpB;AAED,MAAM,WAAW,YAAa,SAAQ,KAAK;IACzC,KAAK,EAAE,eAAe,CAAC;IACvB,SAAS,EAAE,UAAU,CAAC;CACvB;AAED,MAAM,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,EAAE,OAAO,GAAG,SAAS,GAAG,YAAY,GAAG,eAAe,CAAC,CAAC;AAChG,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;AAChD,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,KAAK,MAAM,GAAG,SAAS,CAAC,CAAC;AAEzG,eAAO,MAAM,YAAY,EAAE,MAAM,CAAC,aAAa,GAAG,MAAM,EAAE,YAAY,CAKrE,CAAC;AAEF,MAAM,WAAW,IAAI;IACnB,KAAK,EAAE,kBAAkB,EAAE,CAAC;IAC5B,KAAK,EAAE,IAAI,EAAE,CAAC;CACf;AAED,MAAM,WAAW,IAAI;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,kBAAkB,EAAE,CAAC;CAC7B;AAED,eAAO,MAAM,gBAAgB,kBAA4B,CAAC;AAC1D,MAAM,MAAM,kBAAkB,GAAG,OAAO,GAAG;IAAE,CAAC,gBAAgB,CAAC,EAAE,cAAc,CAAA;CAAE,CAAC;AAElF,MAAM,WAAW,cAAc;IAC7B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,kBAAkB,CAAC;IACzB,QAAQ,CAAC,EAAE,kBAAkB,CAAC;IAC9B,IAAI,EAAE,kBAAkB,CAAC;IACzB,KAAK,EAAE,YAAY,CAAC;CACrB;AAED,MAAM,WAAW,kBAAmB,SAAQ,UAAU;IACpD,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,wBAAgB,SAAS,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,UAAU,EAAE,UAAU,EAAE,UAAU,GAAE,UAAe,GAAG,IAAI,CAsDpG"}

package/dist/site.js

@@ -0,0 +1,86 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildSite = exports.DOC_ITEM_CONTEXT = exports.pageAssigner = void 0;
+const path_1 = __importDefault(require("path"));
+const utils_1 = require("solidity-ast/utils");
+const doc_item_1 = require("./doc-item");
+const clone_1 = require("./utils/clone");
+const is_child_1 = require("./utils/is-child");
+const memoized_getter_1 = require("./utils/memoized-getter");
+exports.pageAssigner = {
+    single: (_1, _2, { pageExtension: ext }) => 'index' + ext,
+    items: (item, _, { pageExtension: ext }) => item.name + ext,
+    files: (_, file, { pageExtension: ext, sourcesDir }) => path_1.default.relative(sourcesDir, file.absolutePath).replace('.sol', ext),
+};
+exports.DOC_ITEM_CONTEXT = '__item_context';
+function buildSite(builds, siteConfig, properties = {}) {
+    const assign = typeof siteConfig.pages === 'string' ? exports.pageAssigner[siteConfig.pages] : siteConfig.pages;
+    const seen = new Set();
+    const items = [];
+    const pages = {};
+    for (let { input, output } of builds) {
+        // Clone because we will mutate in order to add item context.
+        output = { ...output, sources: (0, clone_1.clone)(output.sources) };
+        const deref = (0, utils_1.astDereferencer)(output);
+        const decodeSrc = (0, utils_1.srcDecoder)(input, output);
+        const build = { input, output, deref, decodeSrc };
+        for (const { ast } of Object.values(output.sources)) {
+            const isNewFile = !seen.has(ast.absolutePath);
+            seen.add(ast.absolutePath);
+            const relativePath = path_1.default.relative(siteConfig.sourcesDir, ast.absolutePath);
+            const file = Object.assign(ast, { relativePath });
+            for (const topLevelItem of file.nodes) {
+                if (!(0, doc_item_1.isDocItem)(topLevelItem))
+                    continue;
+                const page = assignIfIncludedSource(assign, topLevelItem, file, siteConfig);
+                const withContext = defineContext(topLevelItem, build, file, page);
+                defineProperties(withContext, properties);
+                if (isNewFile && page !== undefined) {
+                    (pages[page] ?? (pages[page] = [])).push(withContext);
+                    items.push(withContext);
+                }
+                if (!(0, utils_1.isNodeType)('ContractDefinition', topLevelItem)) {
+                    continue;
+                }
+                for (const item of topLevelItem.nodes) {
+                    if (!(0, doc_item_1.isDocItem)(item))
+                        continue;
+                    if (isNewFile && page !== undefined)
+                        items.push(item);
+                    const contract = topLevelItem.nodeType === 'ContractDefinition' ? topLevelItem : undefined;
+                    const withContext = defineContext(item, build, file, page, contract);
+                    defineProperties(withContext, properties);
+                }
+            }
+        }
+    }
+    return {
+        items,
+        pages: Object.entries(pages).map(([id, pageItems]) => ({ id, items: pageItems })),
+    };
+}
+exports.buildSite = buildSite;
+function defineContext(item, build, file, page, contract) {
+    return Object.assign(item, {
+        [exports.DOC_ITEM_CONTEXT]: { build, file, contract, page, item: item },
+    });
+}
+function defineProperties(item, properties) {
+    for (const [prop, fn] of Object.entries(properties)) {
+        const original = item[prop];
+        (0, memoized_getter_1.defineGetterMemoized)(item, prop, () => fn(item.__item_context, original));
+    }
+}
+function assignIfIncludedSource(assign, item, file, config) {
+    return isFileIncluded(file.absolutePath, config)
+        ? assign(item, file, config)
+        : undefined;
+}
+function isFileIncluded(file, config) {
+    return ((0, is_child_1.isChild)(file, config.sourcesDir) &&
+        config.exclude.every(e => !(0, is_child_1.isChild)(file, path_1.default.join(config.sourcesDir, e))));
+}
+//# sourceMappingURL=site.js.map

package/dist/site.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"site.js","sourceRoot":"","sources":["../src/site.ts"],"names":[],"mappings":";;;;;;AAAA,gDAAwB;AAGxB,8CAAmH;AAEnH,yCAA8D;AAE9D,yCAAsC;AACtC,+CAA2C;AAE3C,6DAA+D;AAgBlD,QAAA,YAAY,GAAiD;IACxE,MAAM,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,aAAa,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC,OAAO,GAAG,GAAG;IACzD,KAAK,EAAE,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE,aAAa,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,GAAG,GAAG;IAC3D,KAAK,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,aAAa,EAAE,GAAG,EAAE,UAAU,EAAE,EAAE,EAAE,CACrD,cAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC;CACpE,CAAC;AAYW,QAAA,gBAAgB,GAAG,gBAAyB,CAAC;AAe1D,SAAgB,SAAS,CAAC,MAAe,EAAE,UAAsB,EAAE,aAAyB,EAAE;IAC5F,MAAM,MAAM,GAAG,OAAO,UAAU,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,oBAAY,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC;IAExG,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;IAC/B,MAAM,KAAK,GAAyB,EAAE,CAAC;IACvC,MAAM,KAAK,GAAyC,EAAE,CAAC;IAEvD,KAAK,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,MAAM,EAAE;QACpC,6DAA6D;QAC7D,MAAM,GAAG,EAAE,GAAG,MAAM,EAAE,OAAO,EAAE,IAAA,aAAK,EAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;QAEvD,MAAM,KAAK,GAAG,IAAA,uBAAe,EAAC,MAAM,CAAC,CAAC;QACtC,MAAM,SAAS,GAAG,IAAA,kBAAU,EAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAC5C,MAAM,KAAK,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC;QAElD,KAAK,MAAM,EAAE,GAAG,EAAE,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE;YACnD,MAAM,SAAS,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;YAC9C,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;YAE3B,MAAM,YAAY,GAAG,cAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,UAAU,EAAE,GAAG,CAAC,YAAY,CAAC,CAAC;YAC5E,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,EAAE,YAAY,EAAE,CAAC,CAAC;YAElD,KAAK,MAAM,YAAY,IAAI,IAAI,CAAC,KAAK,EAAE;gBACrC,IAAI,CAAC,IAAA,oBAAS,EAAC,YAAY,CAAC;oBAAE,SAAS;gBAEvC,MAAM,IAAI,GAAG,sBAAsB,CAAC,MAAM,EAAE,YAAY,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC;gBAE5E,MAAM,WAAW,GAAG,aAAa,CAAC,YAAY,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;gBACnE,gBAAgB,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;gBAE1C,IAAI,SAAS,IAAI,IAAI,KAAK,SAAS,EAAE;oBACnC,CAAC,KAAK,CAAC,IAAI,MAAV,KAAK,CAAC,IAAI,IAAM,EAAE,EAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;oBACvC,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;iBACzB;gBAED,IAAI,CAAC,IAAA,kBAAU,EAAC,oBAAoB,EAAE,YAAY,CAAC,EAAE;oBACnD,SAAS;iBACV;gBAED,KAAK,MAAM,IAAI,IAAI,YAAY,CAAC,KAAK,EAAE;oBACrC,IAAI,CAAC,IAAA,oBAAS,EAAC,IAAI,CAAC;wBAAE,SAAS;oBAC/B,IAAI,SAAS,IAAI,IAAI,KAAK,SAAS;wBAAE,KAAK,CAAC,IAAI,CAAC,IAA0B,CAAC,CAAC;oBAC5E,MAAM,QAAQ,GAAG,YAAY,CAAC,QAAQ,KAAK,oBAAoB,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC3F,MAAM,WAAW,GAAG,aAAa,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;oBACrE,gBAAgB,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;iBAC3C;aACF;SACF;KACF;IAED,OAAO;QACL,KAAK;QACL,KAAK,EAAE,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,SAAS,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;KAClF,CAAC;AACJ,CAAC;AAtDD,8BAsDC;AAED,SAAS,aAAa,CAAC,IAAa,EAAE,KAAmB,EAAE,IAAwB,EAAE,IAAa,EAAE,QAA6B;IAC/H,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE;QACzB,CAAC,wBAAgB,CAAC,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,IAA0B,EAAE;KACtF,CAAC,CAAC;AACL,CAAC;AAED,SAAS,gBAAgB,CAAC,IAAwB,EAAE,UAAsB;IACxE,KAAK,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;QACnD,MAAM,QAAQ,GAAa,IAAY,CAAC,IAAI,CAAC,CAAC;QAC9C,IAAA,sCAAoB,EAAC,IAAW,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC,CAAC;KAClF;AACH,CAAC;AAED,SAAS,sBAAsB,CAC7B,MAAoB,EACpB,IAAa,EACb,IAAwB,EACxB,MAAkB;IAElB,OAAO,cAAc,CAAC,IAAI,CAAC,YAAY,EAAE,MAAM,CAAC;QAC9C,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC;QAC5B,CAAC,CAAC,SAAS,CAAC;AAChB,CAAC;AAED,SAAS,cAAc,CAAC,IAAY,EAAE,MAAkB;IACtD,OAAO,CACL,IAAA,kBAAO,EAAC,IAAI,EAAE,MAAM,CAAC,UAAU,CAAC;QAChC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,IAAA,kBAAO,EAAC,IAAI,EAAE,cAAI,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,CAAC,CAC3E,CAAC;AACJ,CAAC"}

package/dist/site.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=site.test.d.ts.map

package/dist/site.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"site.test.d.ts","sourceRoot":"","sources":["../src/site.test.ts"],"names":[],"mappings":""}

package/dist/site.test.js

@@ -0,0 +1,52 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const test_1 = __importDefault(require("./utils/test"));
+const path_1 = __importDefault(require("path"));
+const site_1 = require("./site");
+/**
+ * @param files The name of the Solidity file whose contents should be considered.
+ */
+function testPages(title, opts, expected) {
+    (0, test_1.default)(title, t => {
+        const { files, assign, exclude = [] } = opts;
+        const cfg = {
+            sourcesDir: 'test-contracts',
+            exclude,
+            pageExtension: '.md',
+            pages: (i, f) => files.includes(path_1.default.parse(f.absolutePath).name) ? assign(i, f, cfg) : undefined,
+        };
+        const site = (0, site_1.buildSite)(t.context.build, cfg);
+        const pages = site.pages.map(p => ({
+            id: p.id,
+            items: p.items.map(i => i.name),
+        })).sort((a, b) => a.id.localeCompare(b.id));
+        t.deepEqual(pages, expected);
+    });
+}
+testPages('assign to single page', {
+    files: ['S08_AB'],
+    assign: site_1.pageAssigner.single,
+}, [{ id: 'index.md', items: ['A', 'B'] }]);
+testPages('assign to item pages', {
+    files: ['S08_AB'],
+    assign: site_1.pageAssigner.items,
+}, [
+    { id: 'A.md', items: ['A'] },
+    { id: 'B.md', items: ['B'] },
+]);
+testPages('assign to file pages', {
+    files: ['S08_AB', 'S08_C'],
+    assign: site_1.pageAssigner.files,
+}, [
+    { id: 'S08_AB.md', items: ['A', 'B'] },
+    { id: 'S08_C.md', items: ['C'] },
+]);
+testPages('exclude', {
+    files: ['S08_AB', 'S08_E0'],
+    exclude: ['S08_E0.sol'],
+    assign: site_1.pageAssigner.single,
+}, [{ id: 'index.md', items: ['A', 'B'] }]);
+//# sourceMappingURL=site.test.js.map

package/dist/site.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"site.test.js","sourceRoot":"","sources":["../src/site.test.ts"],"names":[],"mappings":";;;;;AAAA,wDAAgC;AAChC,gDAAwB;AACxB,iCAAiF;AAOjF;;GAEG;AACH,SAAS,SAAS,CAAC,KAAa,EAAE,IAAmE,EAAE,QAAuB;IAC5H,IAAA,cAAI,EAAC,KAAK,EAAE,CAAC,CAAC,EAAE;QACd,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,GAAG,EAAE,EAAE,GAAG,IAAI,CAAC;QAC7C,MAAM,GAAG,GAAe;YACtB,UAAU,EAAE,gBAAgB;YAC5B,OAAO;YACP,aAAa,EAAE,KAAK;YACpB,KAAK,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,cAAI,CAAC,KAAK,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS;SACjG,CAAC;QACF,MAAM,IAAI,GAAG,IAAA,gBAAS,EAAC,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;QAC7C,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;YACjC,EAAE,EAAE,CAAC,CAAC,EAAE;YACR,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;SAChC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAC7C,CAAC,CAAC,SAAS,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IAC/B,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,CAAC,uBAAuB,EAC/B;IACE,KAAK,EAAE,CAAC,QAAQ,CAAC;IACjB,MAAM,EAAE,mBAAY,CAAC,MAAM;CAC5B,EACD,CAAC,EAAE,EAAE,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC,CACxC,CAAC;AAEF,SAAS,CAAC,sBAAsB,EAC9B;IACE,KAAK,EAAE,CAAC,QAAQ,CAAC;IACjB,MAAM,EAAE,mBAAY,CAAC,KAAK;CAC3B,EACD;IACE,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,EAAE;IAC5B,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,EAAE;CAC7B,CACF,CAAC;AAEF,SAAS,CAAC,sBAAsB,EAC9B;IACE,KAAK,EAAE,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC1B,MAAM,EAAE,mBAAY,CAAC,KAAK;CAC3B,EACD;IACE,EAAE,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE;IACtC,EAAE,EAAE,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,EAAE;CACjC,CACF,CAAC;AAEF,SAAS,CAAC,SAAS,EACjB;IACE,KAAK,EAAE,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC3B,OAAO,EAAE,CAAC,YAAY,CAAC;IACvB,MAAM,EAAE,mBAAY,CAAC,MAAM;CAC5B,EACD,CAAC,EAAE,EAAE,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC,CACxC,CAAC"}

package/dist/templates.d.ts

@@ -0,0 +1,23 @@
+import { DocItemContext } from './site';
+export type PropertyGetter = (ctx: DocItemContext, original?: unknown) => unknown;
+export type Properties = Record<string, PropertyGetter>;
+export interface Templates {
+    partials?: Record<string, () => string>;
+    helpers?: Record<string, (...args: unknown[]) => string>;
+    properties?: Record<string, PropertyGetter>;
+}
+/**
+ * Loads the templates that will be used for rendering a site based on a
+ * default theme and user templates.
+ *
+ * The result contains all partials, helpers, and property getters defined in
+ * the user templates and the default theme, where the user's take precedence
+ * if there is a clash. Additionally, all theme partials and helpers are
+ * included with the theme prefix, e.g. `markdown/contract` will be a partial.
+ */
+export declare function loadTemplates(defaultTheme: string, root: string, userTemplatesPath?: string): Promise<Templates>;
+/**
+ * Read templates and helpers from a directory.
+ */
+export declare function readTemplates(partialsDir: string, helpersDir?: string): Promise<Required<Templates>>;
+//# sourceMappingURL=templates.d.ts.map

package/dist/templates.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"templates.d.ts","sourceRoot":"","sources":["../src/templates.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,cAAc,EAAE,MAAM,QAAQ,CAAC;AAIxC,MAAM,MAAM,cAAc,GAAG,CAAC,GAAG,EAAE,cAAc,EAAE,QAAQ,CAAC,EAAE,OAAO,KAAK,OAAO,CAAC;AAClF,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;AAExD,MAAM,WAAW,SAAS;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,MAAM,CAAC,CAAC;IACxC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,MAAM,CAAC,CAAC;IACzD,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;CAC7C;AAED;;;;;;;;GAQG;AACH,wBAAsB,aAAa,CAAC,YAAY,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,iBAAiB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,CA0BtH;AAED;;GAEG;AACH,wBAAsB,aAAa,CAAC,WAAW,EAAE,MAAM,EAAE,UAAU,SAAc,GAAG,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAM/G"}

package/dist/templates.js

@@ -0,0 +1,124 @@
+"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;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.readTemplates = exports.loadTemplates = void 0;
+const path_1 = __importDefault(require("path"));
+const fs_1 = __importStar(require("fs"));
+const map_keys_1 = require("./utils/map-keys");
+const defaultProperties = __importStar(require("./common/properties"));
+/**
+ * Loads the templates that will be used for rendering a site based on a
+ * default theme and user templates.
+ *
+ * The result contains all partials, helpers, and property getters defined in
+ * the user templates and the default theme, where the user's take precedence
+ * if there is a clash. Additionally, all theme partials and helpers are
+ * included with the theme prefix, e.g. `markdown/contract` will be a partial.
+ */
+async function loadTemplates(defaultTheme, root, userTemplatesPath) {
+    const themes = await readThemes();
+    // Initialize templates with the default theme.
+    const templates = {
+        partials: { ...themes[defaultTheme]?.partials },
+        helpers: { ...themes[defaultTheme]?.helpers },
+        properties: { ...defaultProperties },
+    };
+    // Overwrite default theme with user templates.
+    if (userTemplatesPath) {
+        const userTemplates = await readTemplates(path_1.default.resolve(root, userTemplatesPath));
+        Object.assign(templates.partials, userTemplates.partials);
+        Object.assign(templates.helpers, userTemplates.helpers);
+        Object.assign(templates.properties, userTemplates.properties);
+    }
+    // Add partials and helpers from all themes, prefixed with the theme name.
+    for (const [themeName, theme] of Object.entries(themes)) {
+        const addPrefix = (k) => `${themeName}/${k}`;
+        Object.assign(templates.partials, (0, map_keys_1.mapKeys)(theme.partials, addPrefix));
+        Object.assign(templates.helpers, (0, map_keys_1.mapKeys)(theme.helpers, addPrefix));
+    }
+    return templates;
+}
+exports.loadTemplates = loadTemplates;
+/**
+ * Read templates and helpers from a directory.
+ */
+async function readTemplates(partialsDir, helpersDir = partialsDir) {
+    return {
+        partials: await readPartials(partialsDir),
+        helpers: await readHelpers(helpersDir, 'helpers'),
+        properties: await readHelpers(helpersDir, 'properties'),
+    };
+}
+exports.readTemplates = readTemplates;
+async function readPartials(dir) {
+    const partials = {};
+    for (const p of await fs_1.promises.readdir(dir)) {
+        const { name, ext } = path_1.default.parse(p);
+        if (ext === '.hbs') {
+            partials[name] = () => fs_1.default.readFileSync(path_1.default.join(dir, p), 'utf8');
+        }
+    }
+    return partials;
+}
+async function readHelpers(dir, name) {
+    var _a;
+    let helpersPath;
+    try {
+        helpersPath = require.resolve(path_1.default.join(dir, name));
+    }
+    catch {
+        return {};
+    }
+    const h = await (_a = helpersPath, Promise.resolve().then(() => __importStar(require(_a))));
+    const helpers = {};
+    for (const name in h) {
+        if (typeof h[name] === 'function') {
+            helpers[name] = h[name];
+        }
+    }
+    return helpers;
+}
+/**
+ * Reads all built-in themes into an object. Partials will always be found in
+ * src/themes, whereas helpers may instead be found in dist/themes if TypeScript
+ * can't be imported directly.
+ */
+async function readThemes() {
+    const themes = {};
+    // Handlebars partials are located in src and not in dist
+    const srcThemes = path_1.default.resolve(__dirname, '../src/themes');
+    const distThemes = path_1.default.resolve(__dirname, 'themes');
+    for (const theme of await fs_1.promises.readdir(srcThemes, { withFileTypes: true })) {
+        if (theme.isDirectory()) {
+            const { name } = theme;
+            themes[name] = await readTemplates(path_1.default.join(srcThemes, name), path_1.default.join(distThemes, name));
+        }
+    }
+    return themes;
+}
+//# sourceMappingURL=templates.js.map

package/dist/templates.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"templates.js","sourceRoot":"","sources":["../src/templates.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,gDAAwB;AACxB,yCAA+C;AAI/C,+CAA2C;AAG3C,uEAAyD;AAWzD;;;;;;;;GAQG;AACI,KAAK,UAAU,aAAa,CAAC,YAAoB,EAAE,IAAY,EAAE,iBAA0B;IAChG,MAAM,MAAM,GAAG,MAAM,UAAU,EAAE,CAAC;IAElC,+CAA+C;IAC/C,MAAM,SAAS,GAAwB;QACrC,QAAQ,EAAE,EAAE,GAAG,MAAM,CAAC,YAAY,CAAC,EAAE,QAAQ,EAAE;QAC/C,OAAO,EAAE,EAAE,GAAG,MAAM,CAAC,YAAY,CAAC,EAAE,OAAO,EAAE;QAC7C,UAAU,EAAE,EAAE,GAAG,iBAAiB,EAAE;KACrC,CAAC;IAEF,+CAA+C;IAC/C,IAAI,iBAAiB,EAAE;QACrB,MAAM,aAAa,GAAG,MAAM,aAAa,CAAC,cAAI,CAAC,OAAO,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC;QACjF,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,aAAa,CAAC,QAAQ,CAAC,CAAC;QAC1D,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC;QACxD,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,UAAU,EAAE,aAAa,CAAC,UAAU,CAAC,CAAC;KAC/D;IAED,0EAA0E;IAC1E,KAAK,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;QACvD,MAAM,SAAS,GAAG,CAAC,CAAS,EAAE,EAAE,CAAC,GAAG,SAAS,IAAI,CAAC,EAAE,CAAC;QACrD,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAA,kBAAO,EAAC,KAAK,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC;QACtE,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,EAAE,IAAA,kBAAO,EAAC,KAAK,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC;KACrE;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AA1BD,sCA0BC;AAED;;GAEG;AACI,KAAK,UAAU,aAAa,CAAC,WAAmB,EAAE,UAAU,GAAG,WAAW;IAC/E,OAAO;QACL,QAAQ,EAAE,MAAM,YAAY,CAAC,WAAW,CAAC;QACzC,OAAO,EAAE,MAAM,WAAW,CAAC,UAAU,EAAE,SAAS,CAAC;QACjD,UAAU,EAAE,MAAM,WAAW,CAAC,UAAU,EAAE,YAAY,CAAC;KACxD,CAAC;AACJ,CAAC;AAND,sCAMC;AAED,KAAK,UAAU,YAAY,CAAC,GAAW;IACrC,MAAM,QAAQ,GAAuC,EAAE,CAAC;IACxD,KAAK,MAAM,CAAC,IAAI,MAAM,aAAS,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;QAC5C,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,cAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACpC,IAAI,GAAG,KAAK,MAAM,EAAE;YAClB,QAAQ,CAAC,IAAI,CAAC,GAAG,GAAG,EAAE,CAAC,YAAE,CAAC,YAAY,CAAC,cAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;SACnE;KACF;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,KAAK,UAAU,WAAW,CAAC,GAAW,EAAE,IAAY;;IAClD,IAAI,WAAW,CAAC;IAChB,IAAI;QACF,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC,cAAI,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC;KACrD;IAAC,MAAM;QACN,OAAO,EAAE,CAAC;KACX;IACD,MAAM,CAAC,GAAG,YAAa,WAAW,0DAAC,CAAC;IACpC,MAAM,OAAO,GAA4C,EAAE,CAAC;IAC5D,KAAK,MAAM,IAAI,IAAI,CAAC,EAAE;QACpB,IAAI,OAAO,CAAC,CAAC,IAAI,CAAC,KAAK,UAAU,EAAE;YACjC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC;SACzB;KACF;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;;GAIG;AACH,KAAK,UAAU,UAAU;IACvB,MAAM,MAAM,GAAwC,EAAE,CAAC;IAEvD,yDAAyD;IACzD,MAAM,SAAS,GAAG,cAAI,CAAC,OAAO,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC;IAC3D,MAAM,UAAU,GAAG,cAAI,CAAC,OAAO,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IAErD,KAAK,MAAM,KAAK,IAAI,MAAM,aAAS,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,EAAE;QAC/E,IAAI,KAAK,CAAC,WAAW,EAAE,EAAE;YACvB,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,CAAC;YACvB,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,aAAa,CAAC,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,EAAE,cAAI,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC,CAAC;SAC7F;KACF;IAED,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/themes/markdown/helpers.d.ts

@@ -0,0 +1,21 @@
+import { HelperOptions } from 'handlebars';
+export * from '../../common/helpers';
+/**
+ * Returns a Markdown heading marker. An optional number increases the heading level.
+ *
+ *    Input                  Output
+ *    {{h}} {{name}}         # Name
+ *    {{h 2}} {{name}}       ## Name
+ */
+export declare function h(opts: HelperOptions): string;
+export declare function h(hsublevel: number, opts: HelperOptions): string;
+/**
+ * Delineates a section where headings should be increased by 1 or a custom number.
+ *
+ *    {{#hsection}}
+ *    {{>partial-with-headings}}
+ *    {{/hsection}}
+ */
+export declare function hsection(opts: HelperOptions): string;
+export declare function hsection(hsublevel: number, opts: HelperOptions): string;
+//# sourceMappingURL=helpers.d.ts.map

package/dist/themes/markdown/helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../../src/themes/markdown/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAS,MAAM,YAAY,CAAC;AAElD,cAAc,sBAAsB,CAAC;AAErC;;;;;;GAMG;AACH,wBAAgB,CAAC,CAAC,IAAI,EAAE,aAAa,GAAG,MAAM,CAAC;AAC/C,wBAAgB,CAAC,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,GAAG,MAAM,CAAC;AAMlE;;;;;;GAMG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,aAAa,GAAG,MAAM,CAAC;AACtD,wBAAgB,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,GAAG,MAAM,CAAC"}

package/dist/themes/markdown/helpers.js

@@ -0,0 +1,49 @@
+"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.hsection = exports.h = void 0;
+const handlebars_1 = require("handlebars");
+__exportStar(require("../../common/helpers"), exports);
+function h(hsublevel, opts) {
+    const { hlevel } = getHLevel(hsublevel, opts);
+    return new Array(hlevel).fill('#').join('');
+}
+exports.h = h;
+;
+function hsection(hsublevel, opts) {
+    let hlevel;
+    ({ hlevel, opts } = getHLevel(hsublevel, opts));
+    opts.data = handlebars_1.Utils.createFrame(opts.data);
+    opts.data.hlevel = hlevel;
+    return opts.fn(this, opts);
+}
+exports.hsection = hsection;
+/**
+ * Helper for dealing with the optional hsublevel argument.
+ */
+function getHLevel(hsublevel, opts) {
+    if (typeof hsublevel === 'number') {
+        opts = opts;
+        hsublevel = Math.max(1, hsublevel);
+    }
+    else {
+        opts = hsublevel;
+        hsublevel = 1;
+    }
+    const contextHLevel = opts.data?.hlevel ?? 0;
+    return { opts, hlevel: contextHLevel + hsublevel };
+}
+//# sourceMappingURL=helpers.js.map

package/dist/themes/markdown/helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../../src/themes/markdown/helpers.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,2CAAkD;AAElD,uDAAqC;AAWrC,SAAgB,CAAC,CAAC,SAAiC,EAAE,IAAoB;IACvE,MAAM,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;IAC9C,OAAO,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AAC9C,CAAC;AAHD,cAGC;AAAA,CAAC;AAWF,SAAgB,QAAQ,CAAgB,SAAiC,EAAE,IAAoB;IAC7F,IAAI,MAAM,CAAC;IACX,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,SAAS,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC;IAChD,IAAI,CAAC,IAAI,GAAG,kBAAK,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACzC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IAC1B,OAAO,IAAI,CAAC,EAAE,CAAC,IAAe,EAAE,IAAI,CAAC,CAAC;AACxC,CAAC;AAND,4BAMC;AAED;;GAEG;AACH,SAAS,SAAS,CAAC,SAAiC,EAAE,IAAoB;IACxE,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE;QACjC,IAAI,GAAG,IAAK,CAAC;QACb,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC;KACpC;SAAM;QACL,IAAI,GAAG,SAAS,CAAC;QACjB,SAAS,GAAG,CAAC,CAAC;KACf;IACD,MAAM,aAAa,GAAW,IAAI,CAAC,IAAI,EAAE,MAAM,IAAI,CAAC,CAAC;IACrD,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,aAAa,GAAG,SAAS,EAAE,CAAC;AACrD,CAAC"}

package/dist/utils/ItemError.d.ts

@@ -0,0 +1,5 @@
+import { DocItemWithContext } from '../site';
+export declare class ItemError extends Error {
+    constructor(msg: string, item: DocItemWithContext);
+}
+//# sourceMappingURL=ItemError.d.ts.map

package/dist/utils/ItemError.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ItemError.d.ts","sourceRoot":"","sources":["../../src/utils/ItemError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAoB,MAAM,SAAS,CAAC;AAE/D,qBAAa,SAAU,SAAQ,KAAK;gBACtB,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,kBAAkB;CASlD"}

package/dist/utils/ItemError.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ItemError = void 0;
+const site_1 = require("../site");
+class ItemError extends Error {
+    constructor(msg, item) {
+        const ctx = item[site_1.DOC_ITEM_CONTEXT];
+        const src = ctx && ctx.build.decodeSrc(item);
+        if (src) {
+            super(msg + ` (${src})`);
+        }
+        else {
+            super(msg);
+        }
+    }
+}
+exports.ItemError = ItemError;
+//# sourceMappingURL=ItemError.js.map

package/dist/utils/ItemError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ItemError.js","sourceRoot":"","sources":["../../src/utils/ItemError.ts"],"names":[],"mappings":";;;AAAA,kCAA+D;AAE/D,MAAa,SAAU,SAAQ,KAAK;IAClC,YAAY,GAAW,EAAE,IAAwB;QAC/C,MAAM,GAAG,GAAG,IAAI,CAAC,uBAAgB,CAAC,CAAC;QACnC,MAAM,GAAG,GAAG,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAC7C,IAAI,GAAG,EAAE;YACP,KAAK,CAAC,GAAG,GAAG,KAAK,GAAG,GAAG,CAAC,CAAC;SAC1B;aAAM;YACL,KAAK,CAAC,GAAG,CAAC,CAAC;SACZ;IACH,CAAC;CACF;AAVD,8BAUC"}

package/dist/utils/arrays-equal.d.ts

@@ -0,0 +1,3 @@
+export declare function arraysEqual<T>(a: T[], b: T[]): boolean;
+export declare function arraysEqual<T, U>(a: T[], b: T[], mapFn: (x: T) => U): boolean;
+//# sourceMappingURL=arrays-equal.d.ts.map

package/dist/utils/arrays-equal.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"arrays-equal.d.ts","sourceRoot":"","sources":["../../src/utils/arrays-equal.ts"],"names":[],"mappings":"AAAA,wBAAgB,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,OAAO,CAAC;AACxD,wBAAgB,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC"}

package/dist/utils/arrays-equal.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.arraysEqual = void 0;
+function arraysEqual(a, b, mapFn = (x) => x) {
+    return a.length === b.length && a.every((x, i) => mapFn(x) === mapFn(b[i]));
+}
+exports.arraysEqual = arraysEqual;
+//# sourceMappingURL=arrays-equal.js.map

package/dist/utils/arrays-equal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"arrays-equal.js","sourceRoot":"","sources":["../../src/utils/arrays-equal.ts"],"names":[],"mappings":";;;AAEA,SAAgB,WAAW,CAAI,CAAM,EAAE,CAAM,EAAE,QAAQ,CAAC,CAAI,EAAE,EAAE,CAAC,CAAC;IAChE,OAAO,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAE,CAAC,CAAC,CAAC;AAC/E,CAAC;AAFD,kCAEC"}