typedoc 0.27.8 → 0.28.0-beta.0

package/dist/lib/output/plugins/JavascriptIndexPlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"JavascriptIndexPlugin.js","sourceRoot":"","sources":["../../../../src/lib/output/plugins/JavascriptIndexPlugin.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,IAAI,MAAM,MAAM,CAAC;AAGxB,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AACzD,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACzD,OAAO,EAAE,YAAY,EAAE,MAAM,mCAAmC,CAAC;AAEjE,OAAO,EAAE,WAAW,EAAE,MAAM,wCAAwC,CAAC;AACrE,OAAO,EAAE,cAAc,EAAE,MAAM,2CAA2C,CAAC;AAC3E,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAa9B;;;;GAIG;IACU,qBAAqB;sBAAS,iBAAiB;;;;;;;;;;;;;;;;iBAA/C,qBAAsB,SAAQ,WAAiB;;;0CACvD,MAAM,CAAC,kBAAkB,CAAC;2CAG1B,MAAM,CAAC,mBAAmB,CAAC;6CAG3B,MAAM,CAAC,mBAAmB,CAAC;gDAG3B,MAAM,CAAC,sBAAsB,CAAC;iDAG9B,MAAM,CAAC,uBAAuB,CAAC;YAXhC,+LAAiB,cAAc,6BAAd,cAAc,uGAAW;YAG1C,kMAAiB,eAAe,6BAAf,eAAe,yGAAW;YAG3C,wMAAiB,iBAAiB,6BAAjB,iBAAiB,6GAA0B;YAG5D,iNAAiB,oBAAoB,6BAApB,oBAAoB,mHAA0B;YAG/D,oNAAS,qBAAqB,6BAArB,qBAAqB,qHAAW;;;QAZzC,iGAA0C;QAA1C,IAAiB,cAAc,oDAAW;QAA1C,IAAiB,cAAc,0DAAW;QAG1C,iKAA2C;QAA3C,IAAiB,eAAe,qDAAW;QAA3C,IAAiB,eAAe,2DAAW;QAG3C,sKAA4D;QAA5D,IAAiB,iBAAiB,uDAA0B;QAA5D,IAAiB,iBAAiB,6DAA0B;QAG5D,8KAA+D;QAA/D,IAAiB,oBAAoB,0DAA0B;QAA/D,IAAiB,oBAAoB,gEAA0B;QAG/D,mLAAyC;QAAzC,IAAS,qBAAqB,2DAAW;QAAzC,IAAS,qBAAqB,iEAAW;QAEjC,iBAAiB,uEAAG,IAAI,GAAG,EAAU,EAAC;QACtC,eAAe,GAAG,IAAI,GAAG,EAAU,CAAC;QAE5C,YAAY,KAAe;YACvB,KAAK,CAAC,KAAK,CAAC,CAAC;YACb,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,aAAa,CAAC,KAAK,EAAE,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACxE,CAAC;QAEO,eAAe,CAAC,MAAqB;YACzC,IAAI,CAAC,iBAAiB,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC;YACtE,IAAI,CAAC,eAAe,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC,CAAC;YAEvE,IAAI,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,YAAY,YAAY,CAAC,EAAE,CAAC;gBAC9C,OAAO;YACX,CAAC;YAED,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAC;QAChF,CAAC;QAEO,KAAK,CAAC,gBAAgB,CAAC,KAAoB;YAC/C,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,KAAqB,CAAC;YAE/C,MAAM,IAAI,GAAqB,EAAE,CAAC;YAElC,MAAM,oBAAoB,GAAG,IAAI,CAAC,KAAK;iBAClC,MAAO,CAAC,sBAAsB,EAAE;iBAChC,MAAM,CACH,CAAC,IAAI,EAAE,EAAE,CACL,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;gBAC3C,IAAI,CAAC,IAAI;gBACT,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CACwB,CAAC;YAE3D,MAAM,UAAU,GAAG,IAAI,UAAU,CAAC,oBAAoB,CAAC,CAAC;YAExD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,aAAa,EAAE,UAAU,CAAC,CAAC;YAEzD,MAAM,OAAO,GAAG,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACnC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAEnC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YAClB,KACI,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAChC,UAAU,CAAC,kBAAkB,CAChC,EACH,CAAC;gBACC,OAAO,CAAC,KAAK,CAAC,GAAG,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;YAClC,CAAC;YAED,KAAK,MAAM,UAAU,IAAI,UAAU,CAAC,aAAa,EAAE,CAAC;gBAChD,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;gBAExC,IAAI,KAAK,IAAI,CAAC,EAAE,CAAC;oBACb,SAAS;gBACb,CAAC;gBAED,IAAI,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC;gBAC/B,IAAI,MAAM,EAAE,SAAS,EAAE,EAAE,CAAC;oBACtB,MAAM,GAAG,SAAS,CAAC;gBACvB,CAAC;gBAED,MAAM,GAAG,GAAmB;oBACxB,IAAI,EAAE,UAAU,CAAC,IAAI;oBACrB,IAAI,EAAE,UAAU,CAAC,IAAI;oBACrB,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC;oBACxC,OAAO,EAAE,KAAK,CAAC,oBAAoB,CAAC,UAAU,CAAC;iBAClD,CAAC;gBAEF,IAAI,MAAM,EAAE,CAAC;oBACT,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,WAAW,EAAE,CAAC;gBACtC,CAAC;gBAED,OAAO,CAAC,GAAG,CACP;oBACI,IAAI,EAAE,UAAU,CAAC,IAAI;oBACrB,OAAO,EAAE,IAAI,CAAC,oBAAoB,CAAC,UAAU,CAAC;oBAC9C,QAAQ,EAAE,IAAI,CAAC,qBAAqB,CAAC,UAAU,CAAC;oBAChD,GAAG,UAAU,CAAC,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC;oBACvC,EAAE,EAAE,IAAI,CAAC,MAAM;iBAClB,EACD,EAAE,KAAK,EAAE,CACZ,CAAC;gBACF,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACnB,CAAC;YAED,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;YAE9B,MAAM,YAAY,GAAG,IAAI,CAAC,IAAI,CAC1B,KAAK,CAAC,eAAe,EACrB,QAAQ,EACR,WAAW,CACd,CAAC;YAEF,MAAM,IAAI,GAAG;gBACT,IAAI;gBACJ,KAAK;aACR,CAAC;YACF,MAAM,SAAS,CACX,YAAY,EACZ,wBAAwB,MAAM,YAAY,CAAC,IAAI,CAAC,IAAI,CACvD,CAAC;YAEF,IACI,IAAI,CAAC,iBAAiB,CAAC,IAAI;gBAC3B,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,mBAAmB,CAAC,EACrD,CAAC;gBACC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CACxB,IAAI,CAAC,kCAAkC,CACnC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAClD,CACJ,CAAC;YACN,CAAC;YAED,IACI,IAAI,CAAC,eAAe,CAAC,IAAI;gBACzB,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,sBAAsB,CAAC,EACxD,CAAC;gBACC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CACxB,IAAI,CAAC,qCAAqC,CACtC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAChD,CACJ,CAAC;YACN,CAAC;QACL,CAAC;QAEO,QAAQ,CAAC,IAAgD;YAC7D,IAAI,KAAK,GAAG,CAAC,CAAC;YAEd,KACI,MAAM,KAAK,IAAI,WAAW,CAAC,SAAS,CAChC,IAAI,EACJ,IAAI,CAAC,qBAAqB,CAC7B,EACH,CAAC;gBACC,KAAK,IAAI,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBAC5C,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACzC,CAAC;YAED,KAAK,MAAM,GAAG,IAAI,cAAc,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC;gBACnD,KAAK,IAAI,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;gBAC7C,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACrC,CAAC;YAED,OAAO,KAAK,CAAC;QACjB,CAAC;QAEO,oBAAoB,CAAC,UAAsB;YAC/C,IAAI,CAAC,IAAI,CAAC,cAAc;gBAAE,OAAO;YAEjC,MAAM,QAAQ,GAAc,EAAE,CAAC;YAC/B,IAAI,UAAU,CAAC,OAAO;gBAAE,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;YAC1D,IAAI,UAAU,CAAC,aAAa,EAAE,EAAE,CAAC;gBAC7B,UAAU,CAAC,UAAU,EAAE,OAAO,CAC1B,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,CAC/C,CAAC;gBACF,IAAI,UAAU,CAAC,YAAY,EAAE,OAAO,EAAE,CAAC;oBACnC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;gBACnD,CAAC;gBACD,IAAI,UAAU,CAAC,YAAY,EAAE,OAAO,EAAE,CAAC;oBACnC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;gBACnD,CAAC;YACL,CAAC;YAED,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;gBACnB,OAAO;YACX,CAAC;YAED,OAAO,QAAQ;iBACV,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;gBACX,OAAO,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;YACpE,CAAC,CAAC;iBACD,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC;iBACxB,IAAI,CAAC,IAAI,CAAC,CAAC;QACpB,CAAC;QAEO,qBAAqB,CAAC,UAAsB;YAChD,IAAI,CAAC,IAAI,CAAC,eAAe;gBAAE,OAAO;YAElC,IAAI,UAAU,CAAC,UAAU,EAAE,EAAE,CAAC;gBAC1B,OAAO,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAChE,CAAC;QACL,CAAC;;;SArMQ,qBAAqB"}

package/dist/lib/output/plugins/NavigationPlugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NavigationPlugin.d.ts","sourceRoot":"","sources":["../../../../src/lib/output/plugins/NavigationPlugin.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAIrD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAG5C,qBAAa,gBAAiB,SAAQ,iBAAiB;gBACvC,KAAK,EAAE,QAAQ;IAK3B,OAAO,CAAC,eAAe;YAOT,oBAAoB;CAgBrC"}

package/dist/lib/output/plugins/NavigationPlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"NavigationPlugin.js","sourceRoot":"","sources":["../../../../src/lib/output/plugins/NavigationPlugin.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAC7C,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,MAAM,mCAAmC,CAAC;AAEjE,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAEvD,MAAM,OAAO,gBAAiB,SAAQ,iBAAiB;IACnD,YAAY,KAAe;QACvB,KAAK,CAAC,KAAK,CAAC,CAAC;QACb,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,aAAa,CAAC,KAAK,EAAE,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACxE,CAAC;IAEO,eAAe,CAAC,MAAqB;QACzC,IAAI,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,YAAY,YAAY,CAAC,EAAE,CAAC;YAC9C,OAAO;QACX,CAAC;QACD,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC,CAAC;IACpF,CAAC;IAEO,KAAK,CAAC,oBAAoB,CAAC,KAAoB;QACnD,MAAM,YAAY,GAAG,IAAI,CAAC,IAAI,CAC1B,KAAK,CAAC,eAAe,EACrB,QAAQ,EACR,eAAe,CAClB,CAAC;QAEF,MAAM,GAAG,GAAI,IAAI,CAAC,KAAK,CAAC,KAAsB,CAAC,aAAa,CACxD,KAAK,CAAC,OAAO,CAChB,CAAC;QAEF,MAAM,SAAS,CACX,YAAY,EACZ,4BAA4B,MAAM,YAAY,CAAC,GAAG,CAAC,GAAG,CACzD,CAAC;IACN,CAAC;CACJ"}

package/dist/lib/output/plugins/SitemapPlugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SitemapPlugin.d.ts","sourceRoot":"","sources":["../../../../src/lib/output/plugins/SitemapPlugin.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAKrD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAE5C,qBAAa,aAAc,SAAQ,iBAAiB;IAChD,OAAO,KAAK,aAAa,GAGxB;gBAEW,KAAK,EAAE,QAAQ;IAK3B,OAAO,CAAC,eAAe;YAsBT,YAAY;CAkC7B"}

package/dist/lib/output/plugins/SitemapPlugin.js

@@ -2,9 +2,8 @@ import Path from "path";
 import { RendererComponent } from "../components.js";
 import { RendererEvent } from "../events.js";
 import { DefaultTheme } from "../themes/default/DefaultTheme.js";
-import { writeFile } from "../../utils/index.js";
-import { escapeHtml } from "../../utils/html.js";
-import { Fragment } from "../../utils/jsx.js";
+import { writeFile } from "#node-utils";
+import { escapeHtml, JSX } from "#utils";
 export class SitemapPlugin extends RendererComponent {
     get hostedBaseUrl() {
         const url = this.application.options.getValue("hostedBaseUrl");
@@ -29,7 +28,7 @@ export class SitemapPlugin extends RendererComponent {
                     children: [],
                 };
             }
-            return { tag: Fragment, props: null, children: [] };
+            return { tag: JSX.Fragment, props: null, children: [] };
         });
         this.owner.preRenderAsyncJobs.push((event) => this.buildSitemap(event));
     }
@@ -37,13 +36,13 @@ export class SitemapPlugin extends RendererComponent {
         // cSpell:words lastmod urlset
         const sitemapXml = Path.join(event.outputDirectory, "sitemap.xml");
         const lastmod = new Date(this.owner.renderStartTime).toISOString();
-        const urls = event.urls?.map((url) => {
+        const urls = event.pages.map((page) => {
             return {
                 tag: "url",
                 children: [
                     {
                         tag: "loc",
-                        children: new URL(url.url, this.hostedBaseUrl).toString(),
+                        children: new URL(page.url, this.hostedBaseUrl).toString(),
                     },
                     {
                         tag: "lastmod",
@@ -51,7 +50,7 @@ export class SitemapPlugin extends RendererComponent {
                     },
                 ],
             };
-        }) ?? [];
+        });
         const sitemap = `<?xml version="1.0" encoding="UTF-8"?>\n` +
             stringifyXml({
                 tag: "urlset",

package/dist/lib/output/plugins/SitemapPlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SitemapPlugin.js","sourceRoot":"","sources":["../../../../src/lib/output/plugins/SitemapPlugin.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAC7C,OAAO,EAAE,YAAY,EAAE,MAAM,mCAAmC,CAAC;AACjE,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,UAAU,EAAE,GAAG,EAAE,MAAM,QAAQ,CAAC;AAGzC,MAAM,OAAO,aAAc,SAAQ,iBAAiB;IAChD,IAAY,aAAa;QACrB,MAAM,GAAG,GAAG,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;QAC/D,OAAO,CAAC,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,CAAC;IACvD,CAAC;IAED,YAAY,KAAe;QACvB,KAAK,CAAC,KAAK,CAAC,CAAC;QACb,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,aAAa,CAAC,KAAK,EAAE,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACxE,CAAC;IAEO,eAAe,CAAC,MAAqB;QACzC,IAAI,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,YAAY,YAAY,CAAC,EAAE,CAAC;YAC9C,OAAO;QACX,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;YACtB,OAAO;QACX,CAAC;QAED,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,YAAY,EAAE,CAAC,OAAO,EAAE,EAAE;YAC1C,IAAI,OAAO,CAAC,IAAI,CAAC,GAAG,KAAK,YAAY,EAAE,CAAC;gBACpC,OAAO;oBACH,GAAG,EAAE,MAAM;oBACX,KAAK,EAAE,EAAE,GAAG,EAAE,WAAW,EAAE,IAAI,EAAE,IAAI,CAAC,aAAa,EAAE;oBACrD,QAAQ,EAAE,EAAE;iBACf,CAAC;YACN,CAAC;YACD,OAAO,EAAE,GAAG,EAAE,GAAG,CAAC,QAAQ,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;QAC5D,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC;IAC5E,CAAC;IAEO,KAAK,CAAC,YAAY,CAAC,KAAoB;QAC3C,8BAA8B;QAC9B,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,eAAe,EAAE,aAAa,CAAC,CAAC;QACnE,MAAM,OAAO,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,WAAW,EAAE,CAAC;QAEnE,MAAM,IAAI,GAAqB,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;YACpD,OAAO;gBACH,GAAG,EAAE,KAAK;gBACV,QAAQ,EAAE;oBACN;wBACI,GAAG,EAAE,KAAK;wBACV,QAAQ,EAAE,IAAI,GAAG,CACb,IAAI,CAAC,GAAG,EACR,IAAI,CAAC,aAAa,CACrB,CAAC,QAAQ,EAAE;qBACf;oBACD;wBACI,GAAG,EAAE,SAAS;wBACd,QAAQ,EAAE,OAAO;qBACpB;iBACJ;aACJ,CAAC;QACN,CAAC,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,0CAA0C;YACtD,YAAY,CAAC;gBACT,GAAG,EAAE,QAAQ;gBACb,IAAI,EAAE,EAAE,KAAK,EAAE,6CAA6C,EAAE;gBAC9D,QAAQ,EAAE,IAAI;aACjB,CAAC;YACF,IAAI,CAAC;QAET,MAAM,SAAS,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IACzC,CAAC;CACJ;AAQD,SAAS,YAAY,CAAC,GAAmB,EAAE,MAAM,GAAG,CAAC;IACjD,MAAM,KAAK,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;IAElD,KAAK,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC,EAAE,CAAC;QACtD,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,UAAU,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC;IACrD,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAEhB,IAAI,OAAO,GAAG,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;QACnC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC;IACzC,CAAC;SAAM,CAAC;QACJ,KAAK,MAAM,KAAK,IAAI,GAAG,CAAC,QAAQ,EAAE,CAAC;YAC/B,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACjB,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;QAChD,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;IAC1C,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IAE/B,OAAO,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AAC1B,CAAC"}

package/dist/lib/output/plugins/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/lib/output/plugins/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AACzD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC"}

package/dist/lib/output/plugins/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/lib/output/plugins/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AACzD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC"}

package/dist/lib/output/renderer.d.ts

@@ -1,12 +1,13 @@
 import type { Application } from "../application.js";
 import type { Theme } from "./theme.js";
-import { RendererEvent, PageEvent, IndexEvent, type MarkdownEvent } from "./events.js";
-import type { ProjectReflection } from "../models/reflections/project.js";
-import { EventHooks, AbstractComponent } from "../utils/index.js";
-import { type Comment, Reflection } from "../models/index.js";
-import type { JsxElement } from "../utils/jsx.elements.js";
+import { IndexEvent, type MarkdownEvent, PageEvent, RendererEvent } from "./events.js";
+import type { ProjectReflection } from "../models/ProjectReflection.js";
+import { AbstractComponent } from "../utils/index.js";
+import type { Comment, Reflection } from "../models/index.js";
 import type { DefaultThemeRenderContext } from "./themes/default/DefaultThemeRenderContext.js";
+import { EventHooks, JSX } from "#utils";
 import { MarkedPlugin } from "./plugins/index.js";
+import { type Router } from "./router.js";
 /**
  * Describes the hooks available to inject output in the default theme.
  * If the available hooks don't let you put something where you'd like, please open an issue!
@@ -117,6 +118,7 @@ export interface RendererEvents {
  * @group Common
  */
 export declare class Renderer extends AbstractComponent<Application, RendererEvents> {
+    private routers;
     private themes;
     /** @event */
     static readonly EVENT_BEGIN_PAGE = "beginPage";
@@ -152,6 +154,11 @@ export declare class Renderer extends AbstractComponent<Application, RendererEve
      * The theme that is used to render the documentation.
      */
     theme?: Theme;
+    /**
+     * The router which is used to determine the pages to render and
+     * how to link between pages.
+     */
+    router?: Router;
     /**
      * Hooks which will be called when rendering pages.
      * Note:
@@ -160,9 +167,11 @@ export declare class Renderer extends AbstractComponent<Application, RendererEve
      *
      * See {@link RendererHooks} for a description of each available hook, and when it will be called.
      */
-    hooks: EventHooks<RendererHooks, JsxElement>;
+    hooks: EventHooks<RendererHooks, JSX.Element>;
     /** @internal */
     private accessor themeName;
+    /** @internal */
+    private accessor routerName;
     private accessor cleanOutputDir;
     private accessor cname;
     private accessor githubPages;
@@ -184,6 +193,12 @@ export declare class Renderer extends AbstractComponent<Application, RendererEve
      * @param theme
      */
     defineTheme(name: string, theme: new (renderer: Renderer) => Theme): void;
+    /**
+     * Define a new router that can be used to determine the output structure.
+     * @param name
+     * @param router
+     */
+    defineRouter(name: string, router: new (app: Application) => Router): void;
     /**
      * Render the given project reflection to the specified output directory.
      *
@@ -200,14 +215,7 @@ export declare class Renderer extends AbstractComponent<Application, RendererEve
      * @return TRUE if the page has been saved to disc, otherwise FALSE.
      */
     private renderDocument;
-    /**
-     * Ensure that a theme has been setup.
-     *
-     * If a the user has set a theme we try to find and load it. If no theme has
-     * been specified we load the default theme.
-     *
-     * @returns TRUE if a theme has been setup, otherwise FALSE.
-     */
+    private prepareRouter;
     private prepareTheme;
     /**
      * Prepare the output directory. If the directory does not exist, it will be

package/dist/lib/output/renderer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"renderer.d.ts","sourceRoot":"","sources":["../../../src/lib/output/renderer.ts"],"names":[],"mappings":"AAWA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACxC,OAAO,EAAE,UAAU,EAAE,KAAK,aAAa,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AACvF,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AAGxE,OAAO,EAAE,iBAAiB,EAAU,MAAM,mBAAmB,CAAC;AAG9D,OAAO,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAC9D,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,+CAA+C,CAAC;AAC/F,OAAO,EAAE,UAAU,EAAQ,GAAG,EAAE,MAAM,QAAQ,CAAC;AAE/C,OAAO,EAKH,YAAY,EAGf,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAMH,KAAK,MAAM,EAGd,MAAM,aAAa,CAAC;AAErB;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC1B;;OAEG;IACH,YAAY,EAAE,CAAC,yBAAyB,CAAC,CAAC;IAE1C;;OAEG;IACH,UAAU,EAAE,CAAC,yBAAyB,CAAC,CAAC;IAExC;;OAEG;IACH,YAAY,EAAE,CAAC,yBAAyB,CAAC,CAAC;IAE1C;;OAEG;IACH,UAAU,EAAE,CAAC,yBAAyB,CAAC,CAAC;IAExC;;OAEG;IACH,eAAe,EAAE,CAAC,yBAAyB,CAAC,CAAC;IAE7C;;OAEG;IACH,aAAa,EAAE,CAAC,yBAAyB,CAAC,CAAC;IAE3C;;OAEG;IACH,eAAe,EAAE,CAAC,yBAAyB,CAAC,CAAC;IAE7C;;OAEG;IACH,aAAa,EAAE,CAAC,yBAAyB,CAAC,CAAC;IAE3C;;OAEG;IACH,mBAAmB,EAAE,CAAC,yBAAyB,CAAC,CAAC;IAEjD;;OAEG;IACH,iBAAiB,EAAE,CAAC,yBAAyB,CAAC,CAAC;IAE/C;;OAEG;IACH,cAAc,EAAE,CAAC,yBAAyB,CAAC,CAAC;IAE5C;;OAEG;IACH,YAAY,EAAE,CAAC,yBAAyB,CAAC,CAAC;IAE1C;;;;;OAKG;IACH,oBAAoB,EAAE,CAAC,yBAAyB,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;IAEvE;;;;;;OAMG;IACH,mBAAmB,EAAE,CAAC,yBAAyB,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;CACzE;AAED,MAAM,WAAW,cAAc;IAC3B,WAAW,EAAE,CAAC,aAAa,CAAC,CAAC;IAC7B,SAAS,EAAE,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC;IACnC,OAAO,EAAE,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC;IACjC,SAAS,EAAE,CAAC,aAAa,CAAC,CAAC;IAE3B,aAAa,EAAE,CAAC,aAAa,CAAC,CAAC;IAC/B,YAAY,EAAE,CAAC,UAAU,CAAC,CAAC;CAC9B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,qBAAa,QAAS,SAAQ,iBAAiB,CAAC,WAAW,EAAE,cAAc,CAAC;IACxE,OAAO,CAAC,OAAO,CAOZ;IAEH,OAAO,CAAC,MAAM,CAEX;IAEH,aAAa;IACb,MAAM,CAAC,QAAQ,CAAC,gBAAgB,eAAmB;IACnD,aAAa;IACb,MAAM,CAAC,QAAQ,CAAC,cAAc,aAAiB;IAC/C,aAAa;IACb,MAAM,CAAC,QAAQ,CAAC,WAAW,iBAAuB;IAClD,aAAa;IACb,MAAM,CAAC,QAAQ,CAAC,SAAS,eAAqB;IAE9C,aAAa;IACb,MAAM,CAAC,QAAQ,CAAC,mBAAmB,kBAA4B;IAE/D;;;;;;;;OAQG;IACH,kBAAkB,EAAE,KAAK,CAAC,CAAC,MAAM,EAAE,aAAa,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC,CAAM;IAEzE;;;;;;;;OAQG;IACH,mBAAmB,EAAE,KAAK,CAAC,CAAC,MAAM,EAAE,aAAa,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC,CAAM;IAE1E;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC;IAEd;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;;;;OAOG;IACH,KAAK,yCAAgD;IAErD,gBAAgB;IAEhB,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAU;IAEpC,gBAAgB;IAEhB,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAU;IAGrC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAW;IAG1C,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAU;IAGhC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAW;IAEvC,gBAAgB;IAEhB,QAAQ,CAAC,SAAS,EAAG,OAAO,CAAC;IAG7B,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAc;IAGzC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAc;IAGxC,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAY;IAG/C,OAAO,CAAC,QAAQ,CAAC,yBAAyB,CAAY;IAGtD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAW;IAElC,eAAe,SAAM;IAErB,YAAY,EAAE,YAAY,CAAC;gBAEf,KAAK,EAAE,WAAW;IAY9B;;;;;;OAMG;IACH,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,QAAQ,EAAE,QAAQ,KAAK,KAAK;IAOlE;;;;OAIG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,GAAG,EAAE,WAAW,KAAK,MAAM;IAOnE;;;;;OAKG;IACG,MAAM,CACR,OAAO,EAAE,iBAAiB,EAC1B,eAAe,EAAE,MAAM,GACxB,OAAO,CAAC,IAAI,CAAC;YAqCF,gBAAgB;YAYhB,eAAe;IAU7B;;;;;OAKG;IACH,OAAO,CAAC,cAAc;IAyBtB,OAAO,CAAC,aAAa;IAmBrB,OAAO,CAAC,YAAY;IAmBpB;;;;;;OAMG;YACW,sBAAsB;CAmDvC"}

package/dist/lib/output/renderer.js

@@ -42,14 +42,14 @@ var __runInitializers = (this && this.__runInitializers) || function (thisArg, i
  */
 import * as fs from "fs";
 import * as path from "path";
-import { RendererEvent, PageEvent, IndexEvent, } from "./events.js";
+import { IndexEvent, PageEvent, RendererEvent } from "./events.js";
 import { writeFileSync } from "../utils/fs.js";
 import { DefaultTheme } from "./themes/default/DefaultTheme.js";
-import { Option, EventHooks, AbstractComponent } from "../utils/index.js";
+import { AbstractComponent, Option } from "../utils/index.js";
 import { loadHighlighter } from "../utils/highlighter.js";
-import { Reflection } from "../models/index.js";
-import { setRenderSettings } from "../utils/jsx.js";
+import { EventHooks, i18n, JSX } from "#utils";
 import { AssetsPlugin, HierarchyPlugin, IconsPlugin, JavascriptIndexPlugin, MarkedPlugin, NavigationPlugin, SitemapPlugin, } from "./plugins/index.js";
+import { CategoryRouter, GroupRouter, KindDirRouter, KindRouter, StructureDirRouter, StructureRouter, } from "./router.js";
 /**
  * The renderer processes a {@link ProjectReflection} using a {@link Theme} instance and writes
  * the emitted html documents to a output directory. You can specify which theme should be used
@@ -87,6 +87,9 @@ let Renderer = (() => {
     let _themeName_decorators;
     let _themeName_initializers = [];
     let _themeName_extraInitializers = [];
+    let _routerName_decorators;
+    let _routerName_initializers = [];
+    let _routerName_extraInitializers = [];
     let _cleanOutputDir_decorators;
     let _cleanOutputDir_initializers = [];
     let _cleanOutputDir_extraInitializers = [];
@@ -118,6 +121,7 @@ let Renderer = (() => {
         static {
             const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(_classSuper[Symbol.metadata] ?? null) : void 0;
             _themeName_decorators = [Option("theme")];
+            _routerName_decorators = [Option("router")];
             _cleanOutputDir_decorators = [Option("cleanOutputDir")];
             _cname_decorators = [Option("cname")];
             _githubPages_decorators = [Option("githubPages")];
@@ -128,6 +132,7 @@ let Renderer = (() => {
             _ignoredHighlightLanguages_decorators = [Option("ignoredHighlightLanguages")];
             _pretty_decorators = [Option("pretty")];
             __esDecorate(this, null, _themeName_decorators, { kind: "accessor", name: "themeName", static: false, private: false, access: { has: obj => "themeName" in obj, get: obj => obj.themeName, set: (obj, value) => { obj.themeName = value; } }, metadata: _metadata }, _themeName_initializers, _themeName_extraInitializers);
+            __esDecorate(this, null, _routerName_decorators, { kind: "accessor", name: "routerName", static: false, private: false, access: { has: obj => "routerName" in obj, get: obj => obj.routerName, set: (obj, value) => { obj.routerName = value; } }, metadata: _metadata }, _routerName_initializers, _routerName_extraInitializers);
             __esDecorate(this, null, _cleanOutputDir_decorators, { kind: "accessor", name: "cleanOutputDir", static: false, private: false, access: { has: obj => "cleanOutputDir" in obj, get: obj => obj.cleanOutputDir, set: (obj, value) => { obj.cleanOutputDir = value; } }, metadata: _metadata }, _cleanOutputDir_initializers, _cleanOutputDir_extraInitializers);
             __esDecorate(this, null, _cname_decorators, { kind: "accessor", name: "cname", static: false, private: false, access: { has: obj => "cname" in obj, get: obj => obj.cname, set: (obj, value) => { obj.cname = value; } }, metadata: _metadata }, _cname_initializers, _cname_extraInitializers);
             __esDecorate(this, null, _githubPages_decorators, { kind: "accessor", name: "githubPages", static: false, private: false, access: { has: obj => "githubPages" in obj, get: obj => obj.githubPages, set: (obj, value) => { obj.githubPages = value; } }, metadata: _metadata }, _githubPages_initializers, _githubPages_extraInitializers);
@@ -139,6 +144,14 @@ let Renderer = (() => {
             __esDecorate(this, null, _pretty_decorators, { kind: "accessor", name: "pretty", static: false, private: false, access: { has: obj => "pretty" in obj, get: obj => obj.pretty, set: (obj, value) => { obj.pretty = value; } }, metadata: _metadata }, _pretty_initializers, _pretty_extraInitializers);
             if (_metadata) Object.defineProperty(this, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
         }
+        routers = new Map([
+            ["kind", KindRouter],
+            ["structure", StructureRouter],
+            ["kind-dir", KindDirRouter],
+            ["structure-dir", StructureDirRouter],
+            ["group", GroupRouter],
+            ["category", CategoryRouter],
+        ]);
         themes = new Map([
             ["default", DefaultTheme],
         ]);
@@ -176,6 +189,11 @@ let Renderer = (() => {
          * The theme that is used to render the documentation.
          */
         theme;
+        /**
+         * The router which is used to determine the pages to render and
+         * how to link between pages.
+         */
+        router;
         /**
          * Hooks which will be called when rendering pages.
          * Note:
@@ -189,7 +207,11 @@ let Renderer = (() => {
         /** @internal */
         get themeName() { return this.#themeName_accessor_storage; }
         set themeName(value) { this.#themeName_accessor_storage = value; }
-        #cleanOutputDir_accessor_storage = (__runInitializers(this, _themeName_extraInitializers), __runInitializers(this, _cleanOutputDir_initializers, void 0));
+        #routerName_accessor_storage = (__runInitializers(this, _themeName_extraInitializers), __runInitializers(this, _routerName_initializers, void 0));
+        /** @internal */
+        get routerName() { return this.#routerName_accessor_storage; }
+        set routerName(value) { this.#routerName_accessor_storage = value; }
+        #cleanOutputDir_accessor_storage = (__runInitializers(this, _routerName_extraInitializers), __runInitializers(this, _cleanOutputDir_initializers, void 0));
         get cleanOutputDir() { return this.#cleanOutputDir_accessor_storage; }
         set cleanOutputDir(value) { this.#cleanOutputDir_accessor_storage = value; }
         #cname_accessor_storage = (__runInitializers(this, _cleanOutputDir_extraInitializers), __runInitializers(this, _cname_initializers, void 0));
@@ -242,6 +264,17 @@ let Renderer = (() => {
             }
             this.themes.set(name, theme);
         }
+        /**
+         * Define a new router that can be used to determine the output structure.
+         * @param name
+         * @param router
+         */
+        defineRouter(name, router) {
+            if (this.routers.has(name)) {
+                throw new Error(`The router "${name}" has already been defined.`);
+            }
+            this.routers.set(name, router);
+        }
         /**
          * Render the given project reflection to the specified output directory.
          *
@@ -249,25 +282,27 @@ let Renderer = (() => {
          * @param outputDirectory  The path of the directory the documentation should be rendered to.
          */
         async render(project, outputDirectory) {
-            setRenderSettings({ pretty: this.pretty });
+            JSX.setRenderSettings({ pretty: this.pretty });
             const momento = this.hooks.saveMomento();
             this.renderStartTime = Date.now();
-            if (!this.prepareTheme() ||
+            if (!this.prepareRouter() ||
+                !this.prepareTheme() ||
                 !(await this.prepareOutputDirectory(outputDirectory))) {
                 return;
             }
-            const output = new RendererEvent(outputDirectory, project);
-            output.urls = this.theme.getUrls(project);
+            const pages = this.router.buildPages(project);
+            const output = new RendererEvent(outputDirectory, project, pages);
             this.trigger(RendererEvent.BEGIN, output);
             await this.runPreRenderJobs(output);
-            this.application.logger.verbose(`There are ${output.urls.length} pages to write.`);
-            output.urls.forEach((mapping) => {
-                this.renderDocument(...output.createPageEvent(mapping));
-            });
+            this.application.logger.verbose(`There are ${pages.length} pages to write.`);
+            for (const page of pages) {
+                this.renderDocument(outputDirectory, page);
+            }
             await Promise.all(this.postRenderAsyncJobs.map((job) => job(output)));
             this.postRenderAsyncJobs = [];
             this.trigger(RendererEvent.END, output);
             this.theme = void 0;
+            this.router = void 0;
             this.hooks.restoreMomento(momento);
         }
         async runPreRenderJobs(output) {
@@ -288,37 +323,42 @@ let Renderer = (() => {
          * @param page An event describing the current page.
          * @return TRUE if the page has been saved to disc, otherwise FALSE.
          */
-        renderDocument(template, page) {
+        renderDocument(outputDirectory, page) {
             const momento = this.hooks.saveMomento();
-            this.trigger(PageEvent.BEGIN, page);
-            if (page.model instanceof Reflection) {
-                page.contents = this.theme.render(page, template);
-            }
-            else {
-                throw new Error("Should be unreachable");
-            }
-            this.trigger(PageEvent.END, page);
+            const event = new PageEvent(page.model);
+            event.url = page.url;
+            event.filename = path.join(outputDirectory, page.url);
+            event.pageKind = page.kind;
+            event.project = page.model.project;
+            this.trigger(PageEvent.BEGIN, event);
+            event.contents = this.theme.render(event);
+            this.trigger(PageEvent.END, event);
             this.hooks.restoreMomento(momento);
             try {
-                writeFileSync(page.filename, page.contents);
+                writeFileSync(event.filename, event.contents);
             }
             catch (error) {
-                this.application.logger.error(this.application.i18n.could_not_write_0(page.filename));
+                this.application.logger.error(i18n.could_not_write_0(event.filename));
             }
         }
-        /**
-         * Ensure that a theme has been setup.
-         *
-         * If a the user has set a theme we try to find and load it. If no theme has
-         * been specified we load the default theme.
-         *
-         * @returns TRUE if a theme has been setup, otherwise FALSE.
-         */
+        prepareRouter() {
+            if (!this.theme) {
+                const ctor = this.routers.get(this.routerName);
+                if (!ctor) {
+                    this.application.logger.error(i18n.router_0_is_not_defined_available_are_1(this.routerName, [...this.routers.keys()].join(", ")));
+                    return false;
+                }
+                else {
+                    this.router = new ctor(this.application);
+                }
+            }
+            return true;
+        }
         prepareTheme() {
             if (!this.theme) {
                 const ctor = this.themes.get(this.themeName);
                 if (!ctor) {
-                    this.application.logger.error(this.application.i18n.theme_0_is_not_defined_available_are_1(this.themeName, [...this.themes.keys()].join(", ")));
+                    this.application.logger.error(i18n.theme_0_is_not_defined_available_are_1(this.themeName, [...this.themes.keys()].join(", ")));
                     return false;
                 }
                 else {
@@ -343,7 +383,7 @@ let Renderer = (() => {
                     });
                 }
                 catch (error) {
-                    this.application.logger.warn(this.application.i18n.could_not_empty_output_directory_0(directory));
+                    this.application.logger.warn(i18n.could_not_empty_output_directory_0(directory));
                     return false;
                 }
             }
@@ -351,7 +391,7 @@ let Renderer = (() => {
                 fs.mkdirSync(directory, { recursive: true });
             }
             catch (error) {
-                this.application.logger.error(this.application.i18n.could_not_create_output_directory_0(directory));
+                this.application.logger.error(i18n.could_not_create_output_directory_0(directory));
                 return false;
             }
             if (this.githubPages) {
@@ -362,7 +402,7 @@ let Renderer = (() => {
                     fs.writeFileSync(path.join(directory, ".nojekyll"), text);
                 }
                 catch (error) {
-                    this.application.logger.warn(this.application.i18n.could_not_write_0(path.join(directory, ".nojekyll")));
+                    this.application.logger.warn(i18n.could_not_write_0(path.join(directory, ".nojekyll")));
                     return false;
                 }
             }

package/dist/lib/output/renderer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"renderer.js","sourceRoot":"","sources":["../../../src/lib/output/renderer.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;;;;;;;GAOG;AACH,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AACzB,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAI7B,OAAO,EAAE,UAAU,EAAsB,SAAS,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAEvF,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAC/C,OAAO,EAAE,YAAY,EAAE,MAAM,kCAAkC,CAAC;AAChE,OAAO,EAAE,iBAAiB,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAI1D,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,QAAQ,CAAC;AAE/C,OAAO,EACH,YAAY,EACZ,eAAe,EACf,WAAW,EACX,qBAAqB,EACrB,YAAY,EACZ,gBAAgB,EAChB,aAAa,GAChB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACH,cAAc,EACd,WAAW,EACX,aAAa,EACb,UAAU,EAGV,kBAAkB,EAClB,eAAe,GAClB,MAAM,aAAa,CAAC;AA+FrB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;IACU,QAAQ;sBAAS,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAAlC,QAAS,SAAQ,WAA8C;;;qCAsEvE,MAAM,CAAC,OAAO,CAAC;sCAIf,MAAM,CAAC,QAAQ,CAAC;0CAGhB,MAAM,CAAC,gBAAgB,CAAC;iCAGxB,MAAM,CAAC,OAAO,CAAC;uCAGf,MAAM,CAAC,aAAa,CAAC;qCAIrB,MAAM,CAAC,WAAW,CAAC;sCAGnB,MAAM,CAAC,qBAAqB,CAAC;qCAG7B,MAAM,CAAC,oBAAoB,CAAC;8CAG5B,MAAM,CAAC,oBAAoB,CAAC;qDAG5B,MAAM,CAAC,2BAA2B,CAAC;kCAGnC,MAAM,CAAC,QAAQ,CAAC;YA/BjB,gLAAiB,SAAS,6BAAT,SAAS,6FAAU;YAIpC,mLAAiB,UAAU,6BAAV,UAAU,+FAAU;YAGrC,+LAAiB,cAAc,6BAAd,cAAc,uGAAW;YAG1C,oKAAiB,KAAK,6BAAL,KAAK,qFAAU;YAGhC,sLAAiB,WAAW,6BAAX,WAAW,iGAAW;YAIvC,gLAAS,SAAS,6BAAT,SAAS,6FAAW;YAG7B,mLAAiB,UAAU,6BAAV,UAAU,+FAAc;YAGzC,gLAAiB,SAAS,6BAAT,SAAS,6FAAc;YAGxC,2MAAiB,kBAAkB,6BAAlB,kBAAkB,+GAAY;YAG/C,gOAAiB,yBAAyB,6BAAzB,yBAAyB,6HAAY;YAGtD,uKAAiB,MAAM,6BAAN,MAAM,uFAAW;;;QAtG1B,OAAO,GAAG,IAAI,GAAG,CAA2C;YAChE,CAAC,MAAM,EAAE,UAAU,CAAC;YACpB,CAAC,WAAW,EAAE,eAAe,CAAC;YAC9B,CAAC,UAAU,EAAE,aAAa,CAAC;YAC3B,CAAC,eAAe,EAAE,kBAAkB,CAAC;YACrC,CAAC,OAAO,EAAE,WAAW,CAAC;YACtB,CAAC,UAAU,EAAE,cAAc,CAAC;SAC/B,CAAC,CAAC;QAEK,MAAM,GAAG,IAAI,GAAG,CAA4C;YAChE,CAAC,SAAS,EAAE,YAAY,CAAC;SAC5B,CAAC,CAAC;QAEH,aAAa;QACb,MAAM,CAAU,gBAAgB,GAAG,SAAS,CAAC,KAAK,CAAC;QACnD,aAAa;QACb,MAAM,CAAU,cAAc,GAAG,SAAS,CAAC,GAAG,CAAC;QAC/C,aAAa;QACb,MAAM,CAAU,WAAW,GAAG,aAAa,CAAC,KAAK,CAAC;QAClD,aAAa;QACb,MAAM,CAAU,SAAS,GAAG,aAAa,CAAC,GAAG,CAAC;QAE9C,aAAa;QACb,MAAM,CAAU,mBAAmB,GAAG,UAAU,CAAC,aAAa,CAAC;QAE/D;;;;;;;;WAQG;QACH,kBAAkB,GAAoD,EAAE,CAAC;QAEzE;;;;;;;;WAQG;QACH,mBAAmB,GAAoD,EAAE,CAAC;QAE1E;;WAEG;QACH,KAAK,CAAS;QAEd;;;WAGG;QACH,MAAM,CAAU;QAEhB;;;;;;;WAOG;QACH,KAAK,GAAG,IAAI,UAAU,EAA8B,CAAC;QAIrD,uFAAoC;QAFpC,gBAAgB;QAEhB,IAAiB,SAAS,+CAAU;QAApC,IAAiB,SAAS,qDAAU;QAIpC,kJAAqC;QAFrC,gBAAgB;QAEhB,IAAiB,UAAU,gDAAU;QAArC,IAAiB,UAAU,sDAAU;QAGrC,2JAA0C;QAA1C,IAAiB,cAAc,oDAAW;QAA1C,IAAiB,cAAc,0DAAW;QAG1C,6IAAgC;QAAhC,IAAiB,KAAK,2CAAU;QAAhC,IAAiB,KAAK,iDAAU;QAGhC,gJAAuC;QAAvC,IAAiB,WAAW,iDAAW;QAAvC,IAAiB,WAAW,uDAAW;QAIvC,kJAA6B;QAF7B,gBAAgB;QAEhB,IAAS,SAAS,+CAAW;QAA7B,IAAS,SAAS,qDAAW;QAG7B,kJAAyC;QAAzC,IAAiB,UAAU,gDAAc;QAAzC,IAAiB,UAAU,sDAAc;QAGzC,iJAAwC;QAAxC,IAAiB,SAAS,+CAAc;QAAxC,IAAiB,SAAS,qDAAc;QAGxC,kKAA+C;QAA/C,IAAiB,kBAAkB,wDAAY;QAA/C,IAAiB,kBAAkB,8DAAY;QAG/C,yLAAsD;QAAtD,IAAiB,yBAAyB,+DAAY;QAAtD,IAAiB,yBAAyB,qEAAY;QAGtD,0JAAkC;QAAlC,IAAiB,MAAM,4CAAW;QAAlC,IAAiB,MAAM,kDAAW;QAElC,eAAe,wDAAG,CAAC,CAAC,EAAC;QAErB,YAAY,CAAe;QAE3B,YAAY,KAAkB;YAC1B,KAAK,CAAC,KAAK,CAAC,CAAC;YAEb,IAAI,CAAC,YAAY,GAAG,IAAI,YAAY,CAAC,IAAI,CAAC,CAAC;YAC3C,IAAI,YAAY,CAAC,IAAI,CAAC,CAAC;YACvB,IAAI,WAAW,CAAC,IAAI,CAAC,CAAC;YACtB,IAAI,eAAe,CAAC,IAAI,CAAC,CAAC;YAC1B,IAAI,qBAAqB,CAAC,IAAI,CAAC,CAAC;YAChC,IAAI,gBAAgB,CAAC,IAAI,CAAC,CAAC;YAC3B,IAAI,aAAa,CAAC,IAAI,CAAC,CAAC;QAC5B,CAAC;QAED;;;;;;WAMG;QACH,WAAW,CAAC,IAAY,EAAE,KAAwC;YAC9D,IAAI,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;gBACxB,MAAM,IAAI,KAAK,CAAC,cAAc,IAAI,6BAA6B,CAAC,CAAC;YACrE,CAAC;YACD,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QACjC,CAAC;QAED;;;;WAIG;QACH,YAAY,CAAC,IAAY,EAAE,MAAwC;YAC/D,IAAI,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;gBACzB,MAAM,IAAI,KAAK,CAAC,eAAe,IAAI,6BAA6B,CAAC,CAAC;YACtE,CAAC;YACD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACnC,CAAC;QAED;;;;;WAKG;QACH,KAAK,CAAC,MAAM,CACR,OAA0B,EAC1B,eAAuB;YAEvB,GAAG,CAAC,iBAAiB,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;YAE/C,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;YACzC,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YAElC,IACI,CAAC,IAAI,CAAC,aAAa,EAAE;gBACrB,CAAC,IAAI,CAAC,YAAY,EAAE;gBACpB,CAAC,CAAC,MAAM,IAAI,CAAC,sBAAsB,CAAC,eAAe,CAAC,CAAC,EACvD,CAAC;gBACC,OAAO;YACX,CAAC;YAED,MAAM,KAAK,GAAG,IAAI,CAAC,MAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;YAE/C,MAAM,MAAM,GAAG,IAAI,aAAa,CAAC,eAAe,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;YAClE,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;YAC1C,MAAM,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;YAEpC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAC3B,aAAa,KAAK,CAAC,MAAM,kBAAkB,CAC9C,CAAC;YACF,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;gBACvB,IAAI,CAAC,cAAc,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;YAC/C,CAAC;YAED,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;YACtE,IAAI,CAAC,mBAAmB,GAAG,EAAE,CAAC;YAE9B,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;YAExC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,CAAC;YACpB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,CAAC;YACrB,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;QACvC,CAAC;QAEO,KAAK,CAAC,gBAAgB,CAAC,MAAqB;YAChD,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YAEzB,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;YAC9D,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;YACrE,IAAI,CAAC,kBAAkB,GAAG,EAAE,CAAC;YAE7B,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAC3B,8BAA8B,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,IAAI,CACvD,CAAC;QACN,CAAC;QAEO,KAAK,CAAC,eAAe;YACzB,MAAM,eAAe,CACjB,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,SAAS;YACd,+BAA+B;YAC/B,IAAI,CAAC,kBAAuC,EAC5C,IAAI,CAAC,yBAAyB,CACjC,CAAC;QACN,CAAC;QAED;;;;;WAKG;QACK,cAAc,CAAC,eAAuB,EAAE,IAAoB;YAChE,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;YAEzC,MAAM,KAAK,GAAG,IAAI,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACxC,KAAK,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC;YACrB,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;YACtD,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC;YAC3B,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC;YAEnC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;YAErC,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,KAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAE3C,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YACnC,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;YAEnC,IAAI,CAAC;gBACD,aAAa,CAAC,KAAK,CAAC,QAAQ,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;YAClD,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACb,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,KAAK,CACzB,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,QAAQ,CAAC,CACzC,CAAC;YACN,CAAC;QACL,CAAC;QAEO,aAAa;YACjB,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;gBACd,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;gBAC/C,IAAI,CAAC,IAAI,EAAE,CAAC;oBACR,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,KAAK,CACzB,IAAI,CAAC,uCAAuC,CACxC,IAAI,CAAC,UAAU,EACf,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CACtC,CACJ,CAAC;oBACF,OAAO,KAAK,CAAC;gBACjB,CAAC;qBAAM,CAAC;oBACJ,IAAI,CAAC,MAAM,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;gBAC7C,CAAC;YACL,CAAC;YAED,OAAO,IAAI,CAAC;QAChB,CAAC;QAEO,YAAY;YAChB,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;gBACd,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;gBAC7C,IAAI,CAAC,IAAI,EAAE,CAAC;oBACR,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,KAAK,CACzB,IAAI,CAAC,sCAAsC,CACvC,IAAI,CAAC,SAAS,EACd,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CACrC,CACJ,CAAC;oBACF,OAAO,KAAK,CAAC;gBACjB,CAAC;qBAAM,CAAC;oBACJ,IAAI,CAAC,KAAK,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC;gBAChC,CAAC;YACL,CAAC;YAED,OAAO,IAAI,CAAC;QAChB,CAAC;QAED;;;;;;WAMG;QACK,KAAK,CAAC,sBAAsB,CAAC,SAAiB;YAClD,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;gBACtB,IAAI,CAAC;oBACD,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,SAAS,EAAE;wBAC5B,SAAS,EAAE,IAAI;wBACf,KAAK,EAAE,IAAI;qBACd,CAAC,CAAC;gBACP,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACb,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CACxB,IAAI,CAAC,kCAAkC,CACnC,SAAS,CACZ,CACJ,CAAC;oBACF,OAAO,KAAK,CAAC;gBACjB,CAAC;YACL,CAAC;YAED,IAAI,CAAC;gBACD,EAAE,CAAC,SAAS,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YACjD,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACb,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,KAAK,CACzB,IAAI,CAAC,mCAAmC,CACpC,SAAS,CACZ,CACJ,CAAC;gBACF,OAAO,KAAK,CAAC;YACjB,CAAC;YAED,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;gBACnB,IAAI,CAAC;oBACD,MAAM,IAAI,GAAG,uDAAuD;wBAChE,0DAA0D;wBAC1D,oCAAoC,CAAC;oBAEzC,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,WAAW,CAAC,EAAE,IAAI,CAAC,CAAC;gBAC9D,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACb,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CACxB,IAAI,CAAC,iBAAiB,CAClB,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,WAAW,CAAC,CACpC,CACJ,CAAC;oBACF,OAAO,KAAK,CAAC;gBACjB,CAAC;YACL,CAAC;YAED,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;gBACb,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;YAChE,CAAC;YAED,OAAO,IAAI,CAAC;QAChB,CAAC;;;SArVQ,QAAQ"}

package/dist/lib/output/router.d.ts

@@ -0,0 +1,175 @@
+import type { Application } from "../application.js";
+import { type ProjectReflection, type Reflection, ReflectionKind } from "../models/index.js";
+import { type TypeDocOptionMap } from "../utils/index.js";
+import { Slugger } from "./themes/default/Slugger.js";
+/**
+ * The type of page which should be rendered. This may be extended in the future.
+ * @enum
+ */
+export declare const PageKind: {
+    readonly Index: "index";
+    readonly Reflection: "reflection";
+    readonly Document: "document";
+    readonly Hierarchy: "hierarchy";
+};
+export type PageKind = (typeof PageKind)[keyof typeof PageKind];
+export interface PageDefinition {
+    readonly url: string;
+    readonly kind: PageKind;
+    readonly model: Reflection;
+}
+/**
+ * Interface which routers must conform to.
+ */
+export interface Router {
+    /**
+     * Should return a list of pages which should be rendered.
+     * This will be called once per render.
+     */
+    buildPages(project: ProjectReflection): PageDefinition[];
+    /**
+     * Can be used to check if the reflection can be linked to.
+     */
+    hasUrl(reflection: Reflection): boolean;
+    /**
+     * Get a list of all reflections which can be linked to.
+     * This is used for creating the search index.
+     */
+    getLinkableReflections(): Reflection[];
+    /**
+     * Gets an anchor for this reflection within its containing page.
+     * May be undefined if this reflection owns its own page.
+     */
+    getAnchor(refl: Reflection): string | undefined;
+    /**
+     * Returns true if the reflection has its own page, false if embedded within
+     * another page.
+     */
+    hasOwnDocument(refl: Reflection): boolean;
+    /**
+     * Should return a URL which when clicked on the page containing `from`
+     * takes the user to the page/anchor containing `to`.
+     */
+    relativeUrl(from: Reflection, to: Reflection): string;
+    /**
+     * Should return a URL relative to the project base. This is used for
+     * determining links to items in the assets folder.
+     */
+    baseRelativeUrl(from: Reflection, target: string): string;
+    /**
+     * Get the full URL to the reflection. In TypeDoc's default router this
+     * is equivalent to `relativeUrl(project, refl)`, but this might not be
+     * the case for custom routers which place the project somewhere else
+     * besides `index.html`.
+     *
+     * The URL returned by this by the frontend JS when building dynamic URLs
+     * for the search, full hierarchy, and navigation components.
+     */
+    getFullUrl(refl: Reflection): string;
+    /**
+     * Responsible for getting a slugger for the given reflection. If a
+     * reflection is not associated with a page, the slugger for the parent
+     * reflection should be returned instead.
+     */
+    getSlugger(reflection: Reflection): Slugger;
+}
+/**
+ * Base router class intended to make it easier to implement a router.
+ *
+ * Child classes need only {@link getIdealBaseName}, this class will take care
+ * of the recursing through child reflections.
+ * @group Routers
+ */
+export declare abstract class BaseRouter implements Router {
+    readonly application: Application;
+    extension: string;
+    protected usedFileNames: Set<string>;
+    protected sluggers: Map<Reflection, Slugger>;
+    protected fullUrls: Map<Reflection, string>;
+    protected anchors: Map<Reflection, string>;
+    protected accessor sluggerConfiguration: TypeDocOptionMap["sluggerConfiguration"];
+    protected accessor includeHierarchySummary: boolean;
+    constructor(application: Application);
+    /**
+     * Should return the base-relative desired file name for a reflection.
+     * This name may not be used exactly as TypeDoc will detect conflicts
+     * and automatically introduce a unique identifier to the URL to resolve
+     * them.
+     */
+    protected abstract getIdealBaseName(reflection: Reflection): string;
+    buildPages(project: ProjectReflection): PageDefinition[];
+    hasUrl(reflection: Reflection): boolean;
+    getLinkableReflections(): Reflection[];
+    getAnchor(refl: Reflection): string | undefined;
+    hasOwnDocument(refl: Reflection): boolean;
+    relativeUrl(from: Reflection, to: Reflection): string;
+    baseRelativeUrl(from: Reflection, target: string): string;
+    getFullUrl(refl: Reflection): string;
+    getSlugger(reflection: Reflection): Slugger;
+    /**
+     * Should the page kind to use if a reflection should have its own rendered
+     * page in the output. Note that once `undefined` is returned, children of
+     * that reflection will not have their own document.
+     */
+    protected getPageKind(reflection: Reflection): PageKind | undefined;
+    protected buildChildPages(reflection: Reflection, outPages: PageDefinition[]): void;
+    protected buildAnchors(reflection: Reflection, pageReflection: Reflection): void;
+    /** Strip non-url safe characters from the specified string. */
+    protected getUrlSafeName(name: string): string;
+    protected getFileName(baseName: string): string;
+}
+/**
+ * Router which places reflections in folders according to their kind.
+ * @group Routers
+ */
+export declare class KindRouter extends BaseRouter {
+    directories: Map<ReflectionKind, string>;
+    protected getIdealBaseName(reflection: Reflection): string;
+}
+/**
+ * Router which places reflections in folders according to their kind,
+ * but creates each page as `/index.html` to allow for clean URLs.
+ * @group Routers
+ */
+export declare class KindDirRouter extends KindRouter {
+    private fixLink;
+    protected buildChildPages(reflection: Reflection, outPages: PageDefinition[]): void;
+    getFullUrl(refl: Reflection): string;
+    relativeUrl(from: Reflection, to: Reflection): string;
+}
+/**
+ * Router which places reflections in folders according to the module structure.
+ * @group Routers
+ */
+export declare class StructureRouter extends BaseRouter {
+    protected getIdealBaseName(reflection: Reflection): string;
+}
+/**
+ * Router which places reflections in folders according to the module structure,
+ * but creates each page as `/index.html` to allow for clean URLs.
+ * @group Routers
+ */
+export declare class StructureDirRouter extends StructureRouter {
+    private fixLink;
+    protected buildChildPages(reflection: Reflection, outPages: PageDefinition[]): void;
+    getFullUrl(refl: Reflection): string;
+    relativeUrl(from: Reflection, to: Reflection): string;
+}
+/**
+ * Router which places reflections in folders according to `@group` tags.
+ * @group Routers
+ */
+export declare class GroupRouter extends BaseRouter {
+    private accessor groupReferencesByType;
+    private getGroup;
+    protected getIdealBaseName(reflection: Reflection): string;
+}
+/**
+ * Router which places reflections in folders according to `@category` tags.
+ * @group Routers
+ */
+export declare class CategoryRouter extends BaseRouter {
+    private accessor defaultCategory;
+    private getCategory;
+    protected getIdealBaseName(reflection: Reflection): string;
+}

package/dist/lib/output/router.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"router.d.ts","sourceRoot":"","sources":["../../../src/lib/output/router.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAGrD,OAAO,EAEH,KAAK,iBAAiB,EACtB,KAAK,UAAU,EACf,cAAc,EACjB,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAU,KAAK,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAClE,OAAO,EAAE,OAAO,EAAE,MAAM,6BAA6B,CAAC;AAGtD;;;GAGG;AACH,eAAO,MAAM,QAAQ;;;;;CAKX,CAAC;AACX,MAAM,MAAM,QAAQ,GAAG,CAAC,OAAO,QAAQ,CAAC,CAAC,MAAM,OAAO,QAAQ,CAAC,CAAC;AAEhE,MAAM,WAAW,cAAc;IAC3B,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;IACxB,QAAQ,CAAC,KAAK,EAAE,UAAU,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,MAAM;IACnB;;;OAGG;IACH,UAAU,CAAC,OAAO,EAAE,iBAAiB,GAAG,cAAc,EAAE,CAAC;IAEzD;;OAEG;IACH,MAAM,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAAC;IAExC;;;OAGG;IACH,sBAAsB,IAAI,UAAU,EAAE,CAAC;IAEvC;;;OAGG;IACH,SAAS,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,GAAG,SAAS,CAAC;IAEhD;;;OAGG;IACH,cAAc,CAAC,IAAI,EAAE,UAAU,GAAG,OAAO,CAAC;IAE1C;;;OAGG;IACH,WAAW,CAAC,IAAI,EAAE,UAAU,EAAE,EAAE,EAAE,UAAU,GAAG,MAAM,CAAC;IAEtD;;;OAGG;IACH,eAAe,CAAC,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC;IAE1D;;;;;;;;OAQG;IACH,UAAU,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,CAAC;IAErC;;;;OAIG;IACH,UAAU,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAAC;CAC/C;AAED;;;;;;GAMG;AACH,8BAAsB,UAAW,YAAW,MAAM;IAgBlC,QAAQ,CAAC,WAAW,EAAE,WAAW;IAf7C,SAAS,SAAW;IAIpB,SAAS,CAAC,aAAa,cAAqB;IAC5C,SAAS,CAAC,QAAQ,2BAAkC;IACpD,SAAS,CAAC,QAAQ,0BAAiC;IACnD,SAAS,CAAC,OAAO,0BAAiC;IAGlD,SAAS,CAAC,QAAQ,CAAC,oBAAoB,EAAG,gBAAgB,CAAC,sBAAsB,CAAC,CAAC;IAGnF,SAAS,CAAC,QAAQ,CAAC,uBAAuB,EAAG,OAAO,CAAC;gBAEhC,WAAW,EAAE,WAAW;IAE7C;;;;;OAKG;IACH,SAAS,CAAC,QAAQ,CAAC,gBAAgB,CAAC,UAAU,EAAE,UAAU,GAAG,MAAM;IAEnE,UAAU,CAAC,OAAO,EAAE,iBAAiB,GAAG,cAAc,EAAE;IA4CxD,MAAM,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO;IAIvC,sBAAsB,IAAI,UAAU,EAAE;IAItC,SAAS,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,GAAG,SAAS;IAI/C,cAAc,CAAC,IAAI,EAAE,UAAU,GAAG,OAAO;IAIzC,WAAW,CAAC,IAAI,EAAE,UAAU,EAAE,EAAE,EAAE,UAAU,GAAG,MAAM;IA4BrD,eAAe,CAAC,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM;IAUzD,UAAU,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM;IAWpC,UAAU,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO;IAQ3C;;;;OAIG;IACH,SAAS,CAAC,WAAW,CAAC,UAAU,EAAE,UAAU,GAAG,QAAQ,GAAG,SAAS;IAoBnE,SAAS,CAAC,eAAe,CACrB,UAAU,EAAE,UAAU,EACtB,QAAQ,EAAE,cAAc,EAAE,GAC3B,IAAI;IA0BP,SAAS,CAAC,YAAY,CAClB,UAAU,EAAE,UAAU,EACtB,cAAc,EAAE,UAAU,GAC3B,IAAI;IAwDP,+DAA+D;IAC/D,SAAS,CAAC,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAI9C,SAAS,CAAC,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;CAelD;AAED;;;GAGG;AACH,qBAAa,UAAW,SAAQ,UAAU;IACtC,WAAW,8BAUR;cAEgB,gBAAgB,CAAC,UAAU,EAAE,UAAU,GAAG,MAAM;CAWtE;AAED;;;;GAIG;AACH,qBAAa,aAAc,SAAQ,UAAU;IACzC,OAAO,CAAC,OAAO;cAII,eAAe,CAC9B,UAAU,EAAE,UAAU,EACtB,QAAQ,EAAE,cAAc,EAAE,GAC3B,IAAI;IAKE,UAAU,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM;IAIpC,WAAW,CAAC,IAAI,EAAE,UAAU,EAAE,EAAE,EAAE,UAAU,GAAG,MAAM;CAGjE;AAED;;;GAGG;AACH,qBAAa,eAAgB,SAAQ,UAAU;cACxB,gBAAgB,CAAC,UAAU,EAAE,UAAU,GAAG,MAAM;CAqBtE;AAED;;;;GAIG;AACH,qBAAa,kBAAmB,SAAQ,eAAe;IACnD,OAAO,CAAC,OAAO;cAII,eAAe,CAC9B,UAAU,EAAE,UAAU,EACtB,QAAQ,EAAE,cAAc,EAAE,GAC3B,IAAI;IAKE,UAAU,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM;IAIpC,WAAW,CAAC,IAAI,EAAE,UAAU,EAAE,EAAE,EAAE,UAAU,GAAG,MAAM;CAGjE;AAED;;;GAGG;AACH,qBAAa,WAAY,SAAQ,UAAU;IAEvC,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAAW;IAEjD,OAAO,CAAC,QAAQ;cAeG,gBAAgB,CAAC,UAAU,EAAE,UAAU,GAAG,MAAM;CActE;AAED;;;GAGG;AACH,qBAAa,cAAe,SAAQ,UAAU;IAE1C,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAU;IAE1C,OAAO,CAAC,WAAW;cAaA,gBAAgB,CAAC,UAAU,EAAE,UAAU,GAAG,MAAM;CActE"}