typedoc 0.24.6 → 0.24.8

package/dist/lib/application.d.ts

@@ -77,6 +77,15 @@ export declare class Application extends ChildableComponent<Application, Abstrac
     bootstrapWithPlugins(options?: Partial<TypeDocOptions>): Promise<void>;
     /**
      * Initialize TypeDoc without loading plugins.
+     *
+     * @example
+     * Initialize the application with pretty-printing output disabled.
+     * ```ts
+     * const app = new Application();
+     * app.bootstrap({ pretty: false });
+     * ```
+     *
+     * @param options - Options to set during initialization
      */
     bootstrap(options?: Partial<TypeDocOptions>): void;
     private setOptions;

package/dist/lib/application.js

@@ -72,7 +72,7 @@ const supportedVersionMajorMinor = packageInfo.peerDependencies.typescript
  * Both the {@link Converter} and the {@link Renderer} emit a series of events while processing the project.
  * Subscribe to these Events to control the application flow or alter the output.
  */
-let Application = Application_1 = class Application extends component_1.ChildableComponent {
+let Application = exports.Application = Application_1 = class Application extends component_1.ChildableComponent {
     /**
      * Create a new TypeDoc application instance.
      */
@@ -104,6 +104,15 @@ let Application = Application_1 = class Application extends component_1.Childabl
     }
     /**
      * Initialize TypeDoc without loading plugins.
+     *
+     * @example
+     * Initialize the application with pretty-printing output disabled.
+     * ```ts
+     * const app = new Application();
+     * app.bootstrap({ pretty: false });
+     * ```
+     *
+     * @param options - Options to set during initialization
      */
     bootstrap(options = {}) {
         this.options.reset();
@@ -333,6 +342,10 @@ let Application = Application_1 = class Application extends component_1.Childabl
         ].join("\n");
     }
     _convertPackages() {
+        if (!this.options.isSet("entryPoints")) {
+            this.logger.error("No entry points provided to packages mode, documentation cannot be generated.");
+            return;
+        }
         const packageDirs = (0, entry_point_1.getPackageDirectories)(this.logger, this.options, this.options.getValue("entryPoints"));
         if (packageDirs.length === 0) {
             this.logger.error("Failed to find any packages, ensure you have provided at least one directory as an entry point containing package.json");
@@ -343,7 +356,7 @@ let Application = Application_1 = class Application extends component_1.Childabl
         // Generate a json file for each package
         for (const dir of packageDirs) {
             this.logger.info(`Converting project at ${(0, paths_1.nicePath)(dir)}`);
-            const opts = origOptions.copyForPackage();
+            const opts = origOptions.copyForPackage(dir);
             // Invalid links should only be reported after everything has been merged.
             opts.setValue("validation", { invalidLink: false });
             opts.read(this.logger, dir);
@@ -372,6 +385,10 @@ let Application = Application_1 = class Application extends component_1.Childabl
     }
     _merge() {
         const start = Date.now();
+        if (!this.options.isSet("entryPoints")) {
+            this.logger.error("No entry points provided to merge.");
+            return;
+        }
         const rootDir = (0, fs_1.deriveRootDir)(this.entryPoints);
         const entryPoints = this.entryPoints.flatMap((entry) => {
             const result = (0, fs_1.glob)(entry, rootDir);
@@ -385,10 +402,6 @@ let Application = Application_1 = class Application extends component_1.Childabl
             }
             return result;
         });
-        if (entryPoints.length < 1) {
-            this.logger.error("No entry points provided to merge.");
-            return;
-        }
         const jsonProjects = entryPoints.map((path) => {
             try {
                 return JSON.parse((0, fs_1.readFile)(path));
@@ -434,7 +447,6 @@ __decorate([
 __decorate([
     (0, utils_1.BindOption)("entryPoints")
 ], Application.prototype, "entryPoints", void 0);
-Application = Application_1 = __decorate([
+exports.Application = Application = Application_1 = __decorate([
     (0, component_1.Component)({ name: "application", internal: true })
 ], Application);
-exports.Application = Application;

package/dist/lib/converter/comments/blockLexer.js

@@ -202,7 +202,7 @@ function* lexBlockComment2(file, pos, end, linkTags, checker) {
                     }
                 }
                 if (lookahead !== pos + 1 &&
-                    (lookahead === end || /\s/.test(file[lookahead]))) {
+                    (lookahead === end || /[\s}]/.test(file[lookahead]))) {
                     braceStartsType = true;
                     const token = makeToken(lexer_1.TokenSyntaxKind.Tag, lookahead - pos);
                     attachLinkTagResult(token);

package/dist/lib/converter/comments/lexer.js

@@ -10,4 +10,4 @@ var TokenSyntaxKind;
     TokenSyntaxKind["Tag"] = "tag";
     TokenSyntaxKind["Code"] = "code";
     TokenSyntaxKind["TypeAnnotation"] = "type";
-})(TokenSyntaxKind = exports.TokenSyntaxKind || (exports.TokenSyntaxKind = {}));
+})(TokenSyntaxKind || (exports.TokenSyntaxKind = TokenSyntaxKind = {}));

package/dist/lib/converter/comments/lineLexer.js

@@ -138,7 +138,7 @@ function* lexLineComments2(file, pos, end) {
                     }
                 }
                 if (lookahead !== pos + 1 &&
-                    (lookahead === end || /\s/.test(file[lookahead]))) {
+                    (lookahead === end || /[\s}]/.test(file[lookahead]))) {
                     braceStartsType = true;
                     yield makeToken(lexer_1.TokenSyntaxKind.Tag, lookahead - pos);
                     break;

package/dist/lib/converter/comments/rawLexer.js

@@ -142,7 +142,7 @@ function* lexCommentString2(file) {
                     }
                 }
                 if (lookahead !== pos + 1 &&
-                    (lookahead === end || /\s/.test(file[lookahead]))) {
+                    (lookahead === end || /[\s}]/.test(file[lookahead]))) {
                     braceStartsType = true;
                     yield makeToken(lexer_1.TokenSyntaxKind.Tag, lookahead - pos);
                     break;

package/dist/lib/converter/converter.js

@@ -28,7 +28,7 @@ const linkResolver_1 = require("./comments/linkResolver");
 /**
  * Compiles source files using TypeScript and converts compiler symbols to reflections.
  */
-let Converter = Converter_1 = class Converter extends component_1.ChildableComponent {
+let Converter = exports.Converter = Converter_1 = class Converter extends component_1.ChildableComponent {
     get config() {
         return this._config || this._buildCommentParserConfig();
     }
@@ -343,14 +343,13 @@ __decorate([
 __decorate([
     (0, utils_1.BindOption)("useTsLinkResolution")
 ], Converter.prototype, "useTsLinkResolution", void 0);
-Converter = Converter_1 = __decorate([
+exports.Converter = Converter = Converter_1 = __decorate([
     (0, component_1.Component)({
         name: "converter",
         internal: true,
         childClass: components_1.ConverterComponent,
     })
 ], Converter);
-exports.Converter = Converter;
 function getSymbolForModuleLike(context, node) {
     const symbol = context.checker.getSymbolAtLocation(node) ?? node.symbol;
     if (symbol) {

package/dist/lib/converter/plugins/CategoryPlugin.d.ts

@@ -7,6 +7,7 @@ import { ConverterComponent } from "../components";
  * The handler sets the ´category´ property of all reflections.
  */
 export declare class CategoryPlugin extends ConverterComponent {
+    sortFunction: (reflections: DeclarationReflection[]) => void;
     defaultCategory: string;
     categoryOrder: string[];
     categorizeByGroup: boolean;

package/dist/lib/converter/plugins/CategoryPlugin.js

@@ -18,7 +18,7 @@ const utils_1 = require("../../utils");
  *
  * The handler sets the ´category´ property of all reflections.
  */
-let CategoryPlugin = CategoryPlugin_1 = class CategoryPlugin extends components_1.ConverterComponent {
+let CategoryPlugin = exports.CategoryPlugin = CategoryPlugin_1 = class CategoryPlugin extends components_1.ConverterComponent {
     constructor() {
         super(...arguments);
         this.usedBoosts = new Set();
@@ -37,6 +37,7 @@ let CategoryPlugin = CategoryPlugin_1 = class CategoryPlugin extends components_
      * Triggered when the converter begins converting a project.
      */
     onBegin(_context) {
+        this.sortFunction = (0, utils_1.getSortFunction)(this.application.options);
         // Set up static properties
         if (this.defaultCategory) {
             CategoryPlugin_1.defaultCategory = this.defaultCategory;
@@ -123,33 +124,28 @@ let CategoryPlugin = CategoryPlugin_1 = class CategoryPlugin extends components_
      * @returns An array containing all children of the given reflection categorized
      */
     getReflectionCategories(reflections) {
-        const categories = [];
-        let defaultCat;
-        reflections.forEach((child) => {
+        const categories = new Map();
+        for (const child of reflections) {
             const childCategories = this.getCategories(child);
             if (childCategories.size === 0) {
-                if (!defaultCat) {
-                    defaultCat = categories.find((category) => category.title === CategoryPlugin_1.defaultCategory);
-                    if (!defaultCat) {
-                        defaultCat = new models_2.ReflectionCategory(CategoryPlugin_1.defaultCategory);
-                        categories.push(defaultCat);
-                    }
-                }
-                defaultCat.children.push(child);
-                return;
+                childCategories.add(CategoryPlugin_1.defaultCategory);
             }
             for (const childCat of childCategories) {
-                let category = categories.find((cat) => cat.title === childCat);
+                const category = categories.get(childCat);
                 if (category) {
                     category.children.push(child);
-                    continue;
                 }
-                category = new models_2.ReflectionCategory(childCat);
-                category.children.push(child);
-                categories.push(category);
+                else {
+                    const cat = new models_2.ReflectionCategory(childCat);
+                    cat.children.push(child);
+                    categories.set(childCat, cat);
+                }
             }
-        });
-        return categories;
+        }
+        for (const cat of categories.values()) {
+            this.sortFunction(cat.children);
+        }
+        return Array.from(categories.values());
     }
     /**
      * Return the category of a given reflection.
@@ -236,7 +232,6 @@ __decorate([
 __decorate([
     (0, utils_1.BindOption)("searchCategoryBoosts")
 ], CategoryPlugin.prototype, "boosts", void 0);
-CategoryPlugin = CategoryPlugin_1 = __decorate([
+exports.CategoryPlugin = CategoryPlugin = CategoryPlugin_1 = __decorate([
     (0, components_1.Component)({ name: "category" })
 ], CategoryPlugin);
-exports.CategoryPlugin = CategoryPlugin;

package/dist/lib/converter/plugins/CommentPlugin.js

@@ -88,7 +88,7 @@ const NEVER_RENDERED = [
  * - Resolve `@link` tags to point to target reflections
  *
  */
-let CommentPlugin = class CommentPlugin extends components_1.ConverterComponent {
+let CommentPlugin = exports.CommentPlugin = class CommentPlugin extends components_1.ConverterComponent {
     get excludeNotDocumentedKinds() {
         this._excludeKinds ?? (this._excludeKinds = this.application.options
             .getValue("excludeNotDocumentedKinds")
@@ -289,11 +289,15 @@ let CommentPlugin = class CommentPlugin extends components_1.ConverterComponent
         if (!signatures.length) {
             return;
         }
-        const comment = reflection.comment;
+        const comment = reflection.kindOf(models_1.ReflectionKind.ClassOrInterface)
+            ? undefined
+            : reflection.comment;
         // Since this reflection has signatures, remove the comment from the parent
         // reflection. This is important so that in type aliases we don't end up with
         // a comment rendered twice.
-        delete reflection.comment;
+        if (!reflection.kindOf(models_1.ReflectionKind.ClassOrInterface)) {
+            delete reflection.comment;
+        }
         for (const signature of signatures) {
             const childComment = (signature.comment || (signature.comment = comment?.clone()));
             if (!childComment)
@@ -414,10 +418,9 @@ __decorate([
 __decorate([
     (0, utils_1.BindOption)("excludeNotDocumented")
 ], CommentPlugin.prototype, "excludeNotDocumented", void 0);
-CommentPlugin = __decorate([
+exports.CommentPlugin = CommentPlugin = __decorate([
     (0, components_1.Component)({ name: "comment" })
 ], CommentPlugin);
-exports.CommentPlugin = CommentPlugin;
 function inTypeLiteral(refl) {
     while (refl) {
         if (refl.kind === models_1.ReflectionKind.TypeLiteral) {

package/dist/lib/converter/plugins/GroupPlugin.js

@@ -20,7 +20,7 @@ const models_1 = require("../../models");
  *
  * The handler sets the `groups` property of all container reflections.
  */
-let GroupPlugin = GroupPlugin_1 = class GroupPlugin extends components_1.ConverterComponent {
+let GroupPlugin = exports.GroupPlugin = GroupPlugin_1 = class GroupPlugin extends components_1.ConverterComponent {
     constructor() {
         super(...arguments);
         this.usedBoosts = new Set();
@@ -170,7 +170,6 @@ __decorate([
 __decorate([
     (0, utils_1.BindOption)("groupOrder")
 ], GroupPlugin.prototype, "groupOrder", void 0);
-GroupPlugin = GroupPlugin_1 = __decorate([
+exports.GroupPlugin = GroupPlugin = GroupPlugin_1 = __decorate([
     (0, components_1.Component)({ name: "group" })
 ], GroupPlugin);
-exports.GroupPlugin = GroupPlugin;

package/dist/lib/converter/plugins/ImplementsPlugin.js

@@ -22,7 +22,7 @@ const utils_1 = require("../../utils");
  * A plugin that detects interface implementations of functions and
  * properties on classes and links them.
  */
-let ImplementsPlugin = class ImplementsPlugin extends components_1.ConverterComponent {
+let ImplementsPlugin = exports.ImplementsPlugin = class ImplementsPlugin extends components_1.ConverterComponent {
     constructor() {
         super(...arguments);
         this.resolved = new WeakSet();
@@ -224,10 +224,9 @@ let ImplementsPlugin = class ImplementsPlugin extends components_1.ConverterComp
         }
     }
 };
-ImplementsPlugin = __decorate([
+exports.ImplementsPlugin = ImplementsPlugin = __decorate([
     (0, components_1.Component)({ name: "implements" })
 ], ImplementsPlugin);
-exports.ImplementsPlugin = ImplementsPlugin;
 function constructorInheritance(context, reflection, childDecl, constructorDecl) {
     const extendsClause = childDecl.heritageClauses?.find((cl) => cl.token === typescript_1.default.SyntaxKind.ExtendsKeyword);
     if (!extendsClause)

package/dist/lib/converter/plugins/InheritDocPlugin.js

@@ -28,7 +28,7 @@ const application_events_1 = require("../../application-events");
  * - `@typeParam` block
  * - `@return` block
  */
-let InheritDocPlugin = class InheritDocPlugin extends components_1.ConverterComponent {
+let InheritDocPlugin = exports.InheritDocPlugin = class InheritDocPlugin extends components_1.ConverterComponent {
     constructor() {
         super(...arguments);
         // Key is depended on by Values
@@ -159,10 +159,9 @@ let InheritDocPlugin = class InheritDocPlugin extends components_1.ConverterComp
         }
     }
 };
-InheritDocPlugin = __decorate([
+exports.InheritDocPlugin = InheritDocPlugin = __decorate([
     (0, components_1.Component)({ name: "inheritDoc" })
 ], InheritDocPlugin);
-exports.InheritDocPlugin = InheritDocPlugin;
 function copySummaries(source, target) {
     for (const [s, t] of (0, array_1.zip)(source || [], target || [])) {
         t.comment = new models_1.Comment(s.comment?.summary);

package/dist/lib/converter/plugins/LinkResolverPlugin.js

@@ -16,7 +16,7 @@ const application_events_1 = require("../../application-events");
 /**
  * A plugin that resolves `{@link Foo}` tags.
  */
-let LinkResolverPlugin = class LinkResolverPlugin extends components_1.ConverterComponent {
+let LinkResolverPlugin = exports.LinkResolverPlugin = class LinkResolverPlugin extends components_1.ConverterComponent {
     initialize() {
         super.initialize();
         this.owner.on(converter_events_1.ConverterEvents.RESOLVE_END, this.onResolve, this, -300);
@@ -56,7 +56,6 @@ let LinkResolverPlugin = class LinkResolverPlugin extends components_1.Converter
 __decorate([
     (0, utils_1.BindOption)("validation")
 ], LinkResolverPlugin.prototype, "validation", void 0);
-LinkResolverPlugin = __decorate([
+exports.LinkResolverPlugin = LinkResolverPlugin = __decorate([
     (0, components_1.Component)({ name: "link-resolver" })
 ], LinkResolverPlugin);
-exports.LinkResolverPlugin = LinkResolverPlugin;

package/dist/lib/converter/plugins/PackagePlugin.js

@@ -43,7 +43,7 @@ const path_1 = require("path");
  * A handler that tries to find the package.json and readme.md files of the
  * current project.
  */
-let PackagePlugin = class PackagePlugin extends components_1.ConverterComponent {
+let PackagePlugin = exports.PackagePlugin = class PackagePlugin extends components_1.ConverterComponent {
     initialize() {
         this.listenTo(this.owner, {
             [converter_1.Converter.EVENT_BEGIN]: this.onBegin,
@@ -72,7 +72,8 @@ let PackagePlugin = class PackagePlugin extends components_1.ConverterComponent
         const entryFiles = this.entryPointStrategy === utils_1.EntryPointStrategy.Packages
             ? this.entryPoints.map((d) => (0, path_1.join)(d, "package.json"))
             : this.entryPoints;
-        const dirName = Path.resolve((0, fs_1.deriveRootDir)(entryFiles));
+        const dirName = this.application.options.packageDir ??
+            Path.resolve((0, fs_1.deriveRootDir)(entryFiles));
         this.application.logger.verbose(`Begin readme.md/package.json search at ${(0, paths_1.nicePath)(dirName)}`);
         this.packageJson = (0, fs_1.discoverPackageJson)(dirName)?.content;
         // Path will be resolved already. This is kind of ugly, but...
@@ -140,7 +141,6 @@ __decorate([
 __decorate([
     (0, utils_1.BindOption)("includeVersion")
 ], PackagePlugin.prototype, "includeVersion", void 0);
-PackagePlugin = __decorate([
+exports.PackagePlugin = PackagePlugin = __decorate([
     (0, components_1.Component)({ name: "package" })
 ], PackagePlugin);
-exports.PackagePlugin = PackagePlugin;

package/dist/lib/converter/plugins/SourcePlugin.js

@@ -23,7 +23,7 @@ const base_path_1 = require("../utils/base-path");
 /**
  * A handler that attaches source file information to reflections.
  */
-let SourcePlugin = class SourcePlugin extends components_1.ConverterComponent {
+let SourcePlugin = exports.SourcePlugin = class SourcePlugin extends components_1.ConverterComponent {
     constructor() {
         super(...arguments);
         /**
@@ -163,7 +163,6 @@ __decorate([
 __decorate([
     (0, utils_1.BindOption)("basePath")
 ], SourcePlugin.prototype, "basePath", void 0);
-SourcePlugin = __decorate([
+exports.SourcePlugin = SourcePlugin = __decorate([
     (0, components_1.Component)({ name: "source" })
 ], SourcePlugin);
-exports.SourcePlugin = SourcePlugin;

package/dist/lib/converter/plugins/TypePlugin.js

@@ -15,7 +15,7 @@ const application_events_1 = require("../../application-events");
 /**
  * Responsible for adding `implementedBy` / `implementedFrom`
  */
-let TypePlugin = class TypePlugin extends components_1.ConverterComponent {
+let TypePlugin = exports.TypePlugin = class TypePlugin extends components_1.ConverterComponent {
     constructor() {
         super(...arguments);
         this.reflections = new Set();
@@ -121,7 +121,6 @@ let TypePlugin = class TypePlugin extends components_1.ConverterComponent {
         });
     }
 };
-TypePlugin = __decorate([
+exports.TypePlugin = TypePlugin = __decorate([
     (0, components_1.Component)({ name: "type" })
 ], TypePlugin);
-exports.TypePlugin = TypePlugin;

package/dist/lib/models/reflections/abstract.js

@@ -34,7 +34,7 @@ var ReflectionFlag;
     ReflectionFlag[ReflectionFlag["Const"] = 1024] = "Const";
     ReflectionFlag[ReflectionFlag["Let"] = 2048] = "Let";
     ReflectionFlag[ReflectionFlag["Readonly"] = 4096] = "Readonly";
-})(ReflectionFlag = exports.ReflectionFlag || (exports.ReflectionFlag = {}));
+})(ReflectionFlag || (exports.ReflectionFlag = ReflectionFlag = {}));
 const relevantFlags = [
     ReflectionFlag.Private,
     ReflectionFlag.Protected,
@@ -170,6 +170,7 @@ class ReflectionFlags extends Array {
         }
     }
 }
+exports.ReflectionFlags = ReflectionFlags;
 ReflectionFlags.serializedFlags = [
     "isPrivate",
     "isProtected",
@@ -183,7 +184,6 @@ ReflectionFlags.serializedFlags = [
     "isConst",
     "isReadonly",
 ];
-exports.ReflectionFlags = ReflectionFlags;
 var TraverseProperty;
 (function (TraverseProperty) {
     TraverseProperty[TraverseProperty["Children"] = 0] = "Children";
@@ -194,7 +194,7 @@ var TraverseProperty;
     TraverseProperty[TraverseProperty["IndexSignature"] = 5] = "IndexSignature";
     TraverseProperty[TraverseProperty["GetSignature"] = 6] = "GetSignature";
     TraverseProperty[TraverseProperty["SetSignature"] = 7] = "SetSignature";
-})(TraverseProperty = exports.TraverseProperty || (exports.TraverseProperty = {}));
+})(TraverseProperty || (exports.TraverseProperty = TraverseProperty = {}));
 /**
  * Base class for all reflection classes.
  *

package/dist/lib/models/reflections/declaration.js

@@ -15,7 +15,7 @@ var ConversionFlags;
 (function (ConversionFlags) {
     ConversionFlags[ConversionFlags["None"] = 0] = "None";
     ConversionFlags[ConversionFlags["VariableOrPropertySource"] = 1] = "VariableOrPropertySource";
-})(ConversionFlags = exports.ConversionFlags || (exports.ConversionFlags = {}));
+})(ConversionFlags || (exports.ConversionFlags = ConversionFlags = {}));
 /**
  * A reflection that represents a single declaration emitted by the TypeScript compiler.
  *

package/dist/lib/models/reflections/kind.js

@@ -31,7 +31,7 @@ var ReflectionKind;
     ReflectionKind[ReflectionKind["ObjectLiteral"] = 2097152] = "ObjectLiteral";
     ReflectionKind[ReflectionKind["TypeAlias"] = 4194304] = "TypeAlias";
     ReflectionKind[ReflectionKind["Reference"] = 8388608] = "Reference";
-})(ReflectionKind = exports.ReflectionKind || (exports.ReflectionKind = {}));
+})(ReflectionKind || (exports.ReflectionKind = ReflectionKind = {}));
 (function (ReflectionKind) {
     ReflectionKind.All = ReflectionKind.Reference * 2 - 1;
     /** @internal */
@@ -129,7 +129,7 @@ var ReflectionKind;
             .toLowerCase()}`;
     }
     ReflectionKind.classString = classString;
-})(ReflectionKind = exports.ReflectionKind || (exports.ReflectionKind = {}));
+})(ReflectionKind || (exports.ReflectionKind = ReflectionKind = {}));
 function getKindString(kind) {
     return ReflectionKind[kind].replace(/(.)([A-Z])/g, (_m, a, b) => a + " " + b.toLowerCase());
 }

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

@@ -101,6 +101,7 @@ export declare class PageEvent<out Model = unknown> extends Event {
  * An event emitted when markdown is being parsed. Allows other plugins to manipulate the result.
  *
  * @see {@link MarkdownEvent.PARSE}
+ * @see {@link MarkdownEvent.INCLUDE}
  */
 export declare class MarkdownEvent extends Event {
     /**
@@ -120,6 +121,11 @@ export declare class MarkdownEvent extends Event {
      * @event
      */
     static readonly PARSE = "parseMarkdown";
+    /**
+     * Triggered on the renderer when this plugin includes a markdown file through a markdown include tag.
+     * @event
+     */
+    static readonly INCLUDE = "includeMarkdown";
     constructor(name: string, page: PageEvent, originalText: string, parsedText: string);
 }
 /**

package/dist/lib/output/events.js

@@ -54,6 +54,7 @@ class RendererEvent extends events_1.Event {
         return [mapping.template, event];
     }
 }
+exports.RendererEvent = RendererEvent;
 /**
  * Triggered before the renderer starts rendering a project.
  * @event
@@ -64,7 +65,6 @@ RendererEvent.BEGIN = "beginRender";
  * @event
  */
 RendererEvent.END = "endRender";
-exports.RendererEvent = RendererEvent;
 /**
  * An event emitted by the {@link Renderer} class before and after the
  * markup of a page is rendered.
@@ -83,6 +83,7 @@ class PageEvent extends events_1.Event {
         this.model = model;
     }
 }
+exports.PageEvent = PageEvent;
 /**
  * Triggered before a document will be rendered.
  * @event
@@ -93,11 +94,11 @@ PageEvent.BEGIN = "beginPage";
  * @event
  */
 PageEvent.END = "endPage";
-exports.PageEvent = PageEvent;
 /**
  * An event emitted when markdown is being parsed. Allows other plugins to manipulate the result.
  *
  * @see {@link MarkdownEvent.PARSE}
+ * @see {@link MarkdownEvent.INCLUDE}
  */
 class MarkdownEvent extends events_1.Event {
     constructor(name, page, originalText, parsedText) {
@@ -107,12 +108,17 @@ class MarkdownEvent extends events_1.Event {
         this.parsedText = parsedText;
     }
 }
+exports.MarkdownEvent = MarkdownEvent;
 /**
  * Triggered on the renderer when this plugin parses a markdown string.
  * @event
  */
 MarkdownEvent.PARSE = "parseMarkdown";
-exports.MarkdownEvent = MarkdownEvent;
+/**
+ * Triggered on the renderer when this plugin includes a markdown file through a markdown include tag.
+ * @event
+ */
+MarkdownEvent.INCLUDE = "includeMarkdown";
 /**
  * An event emitted when the search index is being prepared.
  */
@@ -144,9 +150,9 @@ class IndexEvent extends events_1.Event {
         this.searchFields = Array.from({ length: this.searchResults.length }, () => ({}));
     }
 }
+exports.IndexEvent = IndexEvent;
 /**
  * Triggered on the renderer when the search index is being prepared.
  * @event
  */
 IndexEvent.PREPARE_INDEX = "prepareIndex";
-exports.IndexEvent = IndexEvent;

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

@@ -19,7 +19,7 @@ const path_1 = require("path");
  * A plugin that copies the subdirectory ´assets´ from the current themes
  * source folder to the output directory.
  */
-let AssetsPlugin = class AssetsPlugin extends components_1.RendererComponent {
+let AssetsPlugin = exports.AssetsPlugin = class AssetsPlugin extends components_1.RendererComponent {
     /**
      * Create a new AssetsPlugin instance.
      */
@@ -57,7 +57,6 @@ let AssetsPlugin = class AssetsPlugin extends components_1.RendererComponent {
 __decorate([
     (0, utils_1.BindOption)("customCss")
 ], AssetsPlugin.prototype, "customCss", void 0);
-AssetsPlugin = __decorate([
+exports.AssetsPlugin = AssetsPlugin = __decorate([
     (0, components_1.Component)({ name: "assets" })
 ], AssetsPlugin);
-exports.AssetsPlugin = AssetsPlugin;

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

@@ -42,7 +42,7 @@ const DefaultTheme_1 = require("../themes/default/DefaultTheme");
  *
  * The resulting javascript file can be used to build a simple search function.
  */
-let JavascriptIndexPlugin = class JavascriptIndexPlugin extends components_1.RendererComponent {
+let JavascriptIndexPlugin = exports.JavascriptIndexPlugin = class JavascriptIndexPlugin extends components_1.RendererComponent {
     /**
      * Create a new JavascriptIndexPlugin instance.
      */
@@ -141,7 +141,6 @@ let JavascriptIndexPlugin = class JavascriptIndexPlugin extends components_1.Ren
 __decorate([
     (0, utils_1.BindOption)("searchInComments")
 ], JavascriptIndexPlugin.prototype, "searchComments", void 0);
-JavascriptIndexPlugin = __decorate([
+exports.JavascriptIndexPlugin = JavascriptIndexPlugin = __decorate([
     (0, components_1.Component)({ name: "javascript-index" })
 ], JavascriptIndexPlugin);
-exports.JavascriptIndexPlugin = JavascriptIndexPlugin;

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

@@ -145,6 +145,8 @@ export declare class Renderer extends ChildableComponent<Application, RendererCo
     lightTheme: ShikiTheme;
     /** @internal */
     darkTheme: ShikiTheme;
+    /** @internal */
+    pretty: boolean;
     renderStartTime: number;
     /**
      * Define a new theme that can be used to render output.

package/dist/lib/output/renderer.js

@@ -82,7 +82,7 @@ const type_1 = require("./themes/default/partials/type");
  *    Triggered when the JavascriptIndexPlugin is preparing the search index. Listeners receive
  *    an instance of {@link IndexEvent}.
  */
-let Renderer = class Renderer extends component_1.ChildableComponent {
+let Renderer = exports.Renderer = class Renderer extends component_1.ChildableComponent {
     constructor() {
         super(...arguments);
         this.themes = new Map([
@@ -139,6 +139,7 @@ let Renderer = class Renderer extends component_1.ChildableComponent {
      * @param outputDirectory  The path of the directory the documentation should be rendered to.
      */
     async render(project, outputDirectory) {
+        (0, jsx_1.setRenderSettings)({ pretty: this.pretty });
         const momento = this.hooks.saveMomento();
         this.renderStartTime = Date.now();
         await (0, highlighter_1.loadHighlighter)(this.lightTheme, this.darkTheme);
@@ -296,10 +297,13 @@ __decorate([
 __decorate([
     (0, utils_1.BindOption)("darkHighlightTheme")
 ], Renderer.prototype, "darkTheme", void 0);
-Renderer = __decorate([
+__decorate([
+    (0, utils_1.BindOption)("pretty")
+], Renderer.prototype, "pretty", void 0);
+exports.Renderer = Renderer = __decorate([
     (0, component_1.Component)({ name: "renderer", internal: true, childClass: components_1.RendererComponent })
 ], Renderer);
-exports.Renderer = Renderer;
 // HACK: THIS HAS TO STAY DOWN HERE
 // if you try to move it up to the top of the file, then you'll run into stuff being used before it has been defined.
 require("./plugins");
+const jsx_1 = require("../utils/jsx");