@firebase/api-documenter 0.1.2-canary.233e117f0

package/dist/nodes/DocTable.js

@@ -0,0 +1,77 @@
+"use strict";
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocTable = void 0;
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+const tsdoc_1 = require("@microsoft/tsdoc");
+const DocTableRow_1 = require("./DocTableRow");
+/**
+ * Represents table, similar to an HTML `<table>` element.
+ */
+class DocTable extends tsdoc_1.DocNode {
+    constructor(parameters, rows) {
+        super(parameters);
+        this.header = new DocTableRow_1.DocTableRow({ configuration: this.configuration });
+        this._rows = [];
+        if (parameters) {
+            if (parameters.headerTitles) {
+                if (parameters.headerCells) {
+                    throw new Error('IDocTableParameters.headerCells and IDocTableParameters.headerTitles' +
+                        ' cannot both be specified');
+                }
+                for (const cellText of parameters.headerTitles) {
+                    this.header.addPlainTextCell(cellText);
+                }
+            }
+            else if (parameters.headerCells) {
+                for (const cell of parameters.headerCells) {
+                    this.header.addCell(cell);
+                }
+            }
+        }
+        if (rows) {
+            for (const row of rows) {
+                this.addRow(row);
+            }
+        }
+    }
+    /** @override */
+    get kind() {
+        return "Table" /* Table */;
+    }
+    get rows() {
+        return this._rows;
+    }
+    addRow(row) {
+        this._rows.push(row);
+    }
+    createAndAddRow() {
+        const row = new DocTableRow_1.DocTableRow({
+            configuration: this.configuration
+        });
+        this.addRow(row);
+        return row;
+    }
+    /** @override */
+    onGetChildNodes() {
+        return [this.header, ...this._rows];
+    }
+}
+exports.DocTable = DocTable;
+//# sourceMappingURL=DocTable.js.map

package/dist/nodes/DocTable.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DocTable.js","sourceRoot":"","sources":["../../src/nodes/DocTable.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;AAEH,4FAA4F;AAC5F,2DAA2D;AAE3D,4CAA+D;AAE/D,+CAA4C;AAW5C;;GAEG;AACH,MAAa,QAAS,SAAQ,eAAO;IAKnC,YACE,UAA+B,EAC/B,IAAiC;QAEjC,KAAK,CAAC,UAAU,CAAC,CAAC;QAElB,IAAI,CAAC,MAAM,GAAG,IAAI,yBAAW,CAAC,EAAE,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC;QACrE,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;QAEhB,IAAI,UAAU,EAAE;YACd,IAAI,UAAU,CAAC,YAAY,EAAE;gBAC3B,IAAI,UAAU,CAAC,WAAW,EAAE;oBAC1B,MAAM,IAAI,KAAK,CACb,sEAAsE;wBACpE,2BAA2B,CAC9B,CAAC;iBACH;gBACD,KAAK,MAAM,QAAQ,IAAI,UAAU,CAAC,YAAY,EAAE;oBAC9C,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;iBACxC;aACF;iBAAM,IAAI,UAAU,CAAC,WAAW,EAAE;gBACjC,KAAK,MAAM,IAAI,IAAI,UAAU,CAAC,WAAW,EAAE;oBACzC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;iBAC3B;aACF;SACF;QAED,IAAI,IAAI,EAAE;YACR,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;gBACtB,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;aAClB;SACF;IACH,CAAC;IAED,gBAAgB;IAChB,IAAW,IAAI;QACb,2BAA+B;IACjC,CAAC;IAED,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAEM,MAAM,CAAC,GAAgB;QAC5B,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACvB,CAAC;IAEM,eAAe;QACpB,MAAM,GAAG,GAAgB,IAAI,yBAAW,CAAC;YACvC,aAAa,EAAE,IAAI,CAAC,aAAa;SAClC,CAAC,CAAC;QACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACjB,OAAO,GAAG,CAAC;IACb,CAAC;IAED,gBAAgB;IACN,eAAe;QACvB,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;IACtC,CAAC;CACF;AAhED,4BAgEC"}

package/dist/nodes/DocTableCell.d.ts

@@ -0,0 +1,31 @@
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { IDocNodeParameters, DocNode, DocSection } from '@microsoft/tsdoc';
+/**
+ * Constructor parameters for {@link DocTableCell}.
+ */
+export interface IDocTableCellParameters extends IDocNodeParameters {
+}
+/**
+ * Represents table cell, similar to an HTML `<td>` element.
+ */
+export declare class DocTableCell extends DocNode {
+    readonly content: DocSection;
+    constructor(parameters: IDocTableCellParameters, sectionChildNodes?: ReadonlyArray<DocNode>);
+    /** @override */
+    get kind(): string;
+}

package/dist/nodes/DocTableCell.js

@@ -0,0 +1,37 @@
+"use strict";
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocTableCell = void 0;
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+const tsdoc_1 = require("@microsoft/tsdoc");
+/**
+ * Represents table cell, similar to an HTML `<td>` element.
+ */
+class DocTableCell extends tsdoc_1.DocNode {
+    constructor(parameters, sectionChildNodes) {
+        super(parameters);
+        this.content = new tsdoc_1.DocSection({ configuration: this.configuration }, sectionChildNodes);
+    }
+    /** @override */
+    get kind() {
+        return "TableCell" /* TableCell */;
+    }
+}
+exports.DocTableCell = DocTableCell;
+//# sourceMappingURL=DocTableCell.js.map

package/dist/nodes/DocTableCell.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DocTableCell.js","sourceRoot":"","sources":["../../src/nodes/DocTableCell.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;AAEH,4FAA4F;AAC5F,2DAA2D;AAE3D,4CAA2E;AAQ3E;;GAEG;AACH,MAAa,YAAa,SAAQ,eAAO;IAGvC,YACE,UAAmC,EACnC,iBAA0C;QAE1C,KAAK,CAAC,UAAU,CAAC,CAAC;QAElB,IAAI,CAAC,OAAO,GAAG,IAAI,kBAAU,CAC3B,EAAE,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE,EACrC,iBAAiB,CAClB,CAAC;IACJ,CAAC;IAED,gBAAgB;IAChB,IAAW,IAAI;QACb,mCAAmC;IACrC,CAAC;CACF;AAnBD,oCAmBC"}

package/dist/nodes/DocTableRow.d.ts

@@ -0,0 +1,38 @@
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { IDocNodeParameters, DocNode } from '@microsoft/tsdoc';
+import { DocTableCell } from './DocTableCell';
+/**
+ * Constructor parameters for {@link DocTableRow}.
+ */
+export interface IDocTableRowParameters extends IDocNodeParameters {
+}
+/**
+ * Represents table row, similar to an HTML `<tr>` element.
+ */
+export declare class DocTableRow extends DocNode {
+    private readonly _cells;
+    constructor(parameters: IDocTableRowParameters, cells?: ReadonlyArray<DocTableCell>);
+    /** @override */
+    get kind(): string;
+    get cells(): ReadonlyArray<DocTableCell>;
+    addCell(cell: DocTableCell): void;
+    createAndAddCell(): DocTableCell;
+    addPlainTextCell(cellContent: string): DocTableCell;
+    /** @override */
+    protected onGetChildNodes(): ReadonlyArray<DocNode | undefined>;
+}

package/dist/nodes/DocTableRow.js

@@ -0,0 +1,68 @@
+"use strict";
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocTableRow = void 0;
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+const tsdoc_1 = require("@microsoft/tsdoc");
+const DocTableCell_1 = require("./DocTableCell");
+/**
+ * Represents table row, similar to an HTML `<tr>` element.
+ */
+class DocTableRow extends tsdoc_1.DocNode {
+    constructor(parameters, cells) {
+        super(parameters);
+        this._cells = [];
+        if (cells) {
+            for (const cell of cells) {
+                this.addCell(cell);
+            }
+        }
+    }
+    /** @override */
+    get kind() {
+        return "TableRow" /* TableRow */;
+    }
+    get cells() {
+        return this._cells;
+    }
+    addCell(cell) {
+        this._cells.push(cell);
+    }
+    createAndAddCell() {
+        const newCell = new DocTableCell_1.DocTableCell({
+            configuration: this.configuration
+        });
+        this.addCell(newCell);
+        return newCell;
+    }
+    addPlainTextCell(cellContent) {
+        const cell = this.createAndAddCell();
+        cell.content.appendNodeInParagraph(new tsdoc_1.DocPlainText({
+            configuration: this.configuration,
+            text: cellContent
+        }));
+        return cell;
+    }
+    /** @override */
+    onGetChildNodes() {
+        return this._cells;
+    }
+}
+exports.DocTableRow = DocTableRow;
+//# sourceMappingURL=DocTableRow.js.map

package/dist/nodes/DocTableRow.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DocTableRow.js","sourceRoot":"","sources":["../../src/nodes/DocTableRow.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;AAEH,4FAA4F;AAC5F,2DAA2D;AAE3D,4CAA6E;AAE7E,iDAA8C;AAO9C;;GAEG;AACH,MAAa,WAAY,SAAQ,eAAO;IAGtC,YACE,UAAkC,EAClC,KAAmC;QAEnC,KAAK,CAAC,UAAU,CAAC,CAAC;QAElB,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;QACjB,IAAI,KAAK,EAAE;YACT,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;gBACxB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;aACpB;SACF;IACH,CAAC;IAED,gBAAgB;IAChB,IAAW,IAAI;QACb,iCAAkC;IACpC,CAAC;IAED,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAEM,OAAO,CAAC,IAAkB;QAC/B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACzB,CAAC;IAEM,gBAAgB;QACrB,MAAM,OAAO,GAAiB,IAAI,2BAAY,CAAC;YAC7C,aAAa,EAAE,IAAI,CAAC,aAAa;SAClC,CAAC,CAAC;QACH,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACtB,OAAO,OAAO,CAAC;IACjB,CAAC;IAEM,gBAAgB,CAAC,WAAmB;QACzC,MAAM,IAAI,GAAiB,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACnD,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAChC,IAAI,oBAAY,CAAC;YACf,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,IAAI,EAAE,WAAW;SAClB,CAAC,CACH,CAAC;QACF,OAAO,IAAI,CAAC;IACd,CAAC;IAED,gBAAgB;IACN,eAAe;QACvB,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;CACF;AArDD,kCAqDC"}

package/dist/plugin/IApiDocumenterPluginManifest.d.ts

@@ -0,0 +1,85 @@
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { MarkdownDocumenterFeature } from './MarkdownDocumenterFeature';
+import { PluginFeatureInitialization } from './PluginFeature';
+/**
+ * Defines a "feature" that is provided by an API Documenter plugin.  A feature is a user-defined module
+ * that customizes the behavior of API Documenter.
+ *
+ * @public
+ */
+export interface IFeatureDefinition {
+    /**
+     * The name of this feature, as it will appear in the config file.
+     *
+     * The name should consist of one or more words separated by hyphens.  Each word should consist of lower case
+     * letters and numbers.  Example: `my-feature`
+     */
+    featureName: string;
+    /**
+     * Determines the kind of feature.  The specified value is the name of the base class that `subclass` inherits from.
+     *
+     * @remarks
+     * For now, `MarkdownDocumenterFeature` is the only supported value.
+     */
+    kind: 'MarkdownDocumenterFeature';
+    /**
+     * Your subclass that extends from the base class.
+     */
+    subclass: {
+        new (initialization: PluginFeatureInitialization): MarkdownDocumenterFeature;
+    };
+}
+/**
+ * The manifest for an API Documenter plugin.
+ *
+ * @remarks
+ * An API documenter plugin is an NPM package. By convention, the NPM package name should have the prefix
+ * `doc-plugin-`.  Its main entry point should export an object named `apiDocumenterPluginManifest` which implements
+ * the `IApiDocumenterPluginManifest` interface.
+ *
+ * For example:
+ * ```ts
+ * class MyMarkdownDocumenter extends MarkdownDocumenterFeature {
+ *   public onInitialized(): void {
+ *     console.log('MyMarkdownDocumenter: onInitialized()');
+ *   }
+ * }
+ *
+ * export const apiDocumenterPluginManifest: IApiDocumenterPluginManifest = {
+ *   manifestVersion: 1000,
+ *   features: [
+ *     {
+ *       featureName: 'my-markdown-documenter',
+ *       kind: 'MarkdownDocumenterFeature',
+ *       subclass: MyMarkdownDocumenter
+ *     }
+ *   ]
+ * };
+ * ```
+ * @public
+ */
+export interface IApiDocumenterPluginManifest {
+    /**
+     * The manifest version number.  For now, this must always be `1000`.
+     */
+    manifestVersion: 1000;
+    /**
+     * The list of features provided by this plugin.
+     */
+    features: IFeatureDefinition[];
+}

package/dist/plugin/IApiDocumenterPluginManifest.js

@@ -0,0 +1,19 @@
+"use strict";
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IApiDocumenterPluginManifest.js.map

package/dist/plugin/IApiDocumenterPluginManifest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IApiDocumenterPluginManifest.js","sourceRoot":"","sources":["../../src/plugin/IApiDocumenterPluginManifest.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG"}

package/dist/plugin/MarkdownDocumenterAccessor.d.ts

@@ -0,0 +1,41 @@
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { ApiItem } from 'api-extractor-model-me';
+/** @internal */
+export interface IMarkdownDocumenterAccessorImplementation {
+    getLinkForApiItem(apiItem: ApiItem): string | undefined;
+}
+/**
+ * Provides access to the documenter that is generating the output.
+ *
+ * @privateRemarks
+ * This class is wrapper that provides access to the underlying MarkdownDocumenter, while hiding the implementation
+ * details to ensure that the plugin API contract is stable.
+ *
+ * @public
+ */
+export declare class MarkdownDocumenterAccessor {
+    private _implementation;
+    /** @internal */
+    constructor(implementation: IMarkdownDocumenterAccessorImplementation);
+    /**
+     * For a given `ApiItem`, return its markdown hyperlink.
+     *
+     * @returns The hyperlink, or `undefined` if the `ApiItem` object does not have a hyperlink.
+     */
+    getLinkForApiItem(apiItem: ApiItem): string | undefined;
+}

package/dist/plugin/MarkdownDocumenterAccessor.js

@@ -0,0 +1,44 @@
+"use strict";
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MarkdownDocumenterAccessor = void 0;
+/**
+ * Provides access to the documenter that is generating the output.
+ *
+ * @privateRemarks
+ * This class is wrapper that provides access to the underlying MarkdownDocumenter, while hiding the implementation
+ * details to ensure that the plugin API contract is stable.
+ *
+ * @public
+ */
+class MarkdownDocumenterAccessor {
+    /** @internal */
+    constructor(implementation) {
+        this._implementation = implementation;
+    }
+    /**
+     * For a given `ApiItem`, return its markdown hyperlink.
+     *
+     * @returns The hyperlink, or `undefined` if the `ApiItem` object does not have a hyperlink.
+     */
+    getLinkForApiItem(apiItem) {
+        return this._implementation.getLinkForApiItem(apiItem);
+    }
+}
+exports.MarkdownDocumenterAccessor = MarkdownDocumenterAccessor;
+//# sourceMappingURL=MarkdownDocumenterAccessor.js.map

package/dist/plugin/MarkdownDocumenterAccessor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MarkdownDocumenterAccessor.js","sourceRoot":"","sources":["../../src/plugin/MarkdownDocumenterAccessor.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;AAYH;;;;;;;;GAQG;AACH,MAAa,0BAA0B;IAGrC,gBAAgB;IAChB,YACE,cAAyD;QAEzD,IAAI,CAAC,eAAe,GAAG,cAAc,CAAC;IACxC,CAAC;IAED;;;;OAIG;IACI,iBAAiB,CAAC,OAAgB;QACvC,OAAO,IAAI,CAAC,eAAe,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;IACzD,CAAC;CACF;AAlBD,gEAkBC"}

package/dist/plugin/MarkdownDocumenterFeature.d.ts

@@ -0,0 +1,88 @@
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { ApiItem, ApiModel } from 'api-extractor-model-me';
+import { PluginFeature } from './PluginFeature';
+import { MarkdownDocumenterAccessor } from './MarkdownDocumenterAccessor';
+/**
+ * Context object for {@link MarkdownDocumenterFeature}.
+ * Exposes various services that can be used by a plugin.
+ *
+ * @public
+ */
+export declare class MarkdownDocumenterFeatureContext {
+    /**
+     * Provides access to the `ApiModel` for the documentation being generated.
+     */
+    readonly apiModel: ApiModel;
+    /**
+     * The full path to the output folder.
+     */
+    readonly outputFolder: string;
+    /**
+     * Exposes functionality of the documenter.
+     */
+    readonly documenter: MarkdownDocumenterAccessor;
+    /** @internal */
+    constructor(options: MarkdownDocumenterFeatureContext);
+}
+/**
+ * Event arguments for MarkdownDocumenterFeature.onBeforeWritePage()
+ * @public
+ */
+export interface IMarkdownDocumenterFeatureOnBeforeWritePageArgs {
+    /**
+     * The API item corresponding to this page.
+     */
+    readonly apiItem: ApiItem;
+    /**
+     * The page content.  The {@link MarkdownDocumenterFeature.onBeforeWritePage} handler can reassign this
+     * string to customize the page appearance.
+     */
+    pageContent: string;
+    /**
+     * The filename where the output will be written.
+     */
+    readonly outputFilename: string;
+}
+/**
+ * Event arguments for MarkdownDocumenterFeature.onFinished()
+ * @public
+ */
+export interface IMarkdownDocumenterFeatureOnFinishedArgs {
+}
+/**
+ * Inherit from this base class to implement an API Documenter plugin feature that customizes
+ * the generation of markdown output.
+ *
+ * @public
+ */
+export declare class MarkdownDocumenterFeature extends PluginFeature {
+    /** {@inheritdoc PluginFeature.context} */
+    context: MarkdownDocumenterFeatureContext;
+    /**
+     * This event occurs before each markdown file is written.  It provides an opportunity to customize the
+     * content of the file.
+     * @virtual
+     */
+    onBeforeWritePage(eventArgs: IMarkdownDocumenterFeatureOnBeforeWritePageArgs): void;
+    /**
+     * This event occurs after all output files have been written.
+     * @virtual
+     */
+    onFinished(eventArgs: IMarkdownDocumenterFeatureOnFinishedArgs): void;
+    static [Symbol.hasInstance](instance: object): boolean;
+}

package/dist/plugin/MarkdownDocumenterFeature.js

@@ -0,0 +1,66 @@
+"use strict";
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MarkdownDocumenterFeature = exports.MarkdownDocumenterFeatureContext = void 0;
+const node_core_library_1 = require("@rushstack/node-core-library");
+const PluginFeature_1 = require("./PluginFeature");
+/**
+ * Context object for {@link MarkdownDocumenterFeature}.
+ * Exposes various services that can be used by a plugin.
+ *
+ * @public
+ */
+class MarkdownDocumenterFeatureContext {
+    /** @internal */
+    constructor(options) {
+        this.apiModel = options.apiModel;
+        this.outputFolder = options.outputFolder;
+        this.documenter = options.documenter;
+    }
+}
+exports.MarkdownDocumenterFeatureContext = MarkdownDocumenterFeatureContext;
+const uuidMarkdownDocumenterFeature = '34196154-9eb3-4de0-a8c8-7e9539dfe216';
+/**
+ * Inherit from this base class to implement an API Documenter plugin feature that customizes
+ * the generation of markdown output.
+ *
+ * @public
+ */
+class MarkdownDocumenterFeature extends PluginFeature_1.PluginFeature {
+    /**
+     * This event occurs before each markdown file is written.  It provides an opportunity to customize the
+     * content of the file.
+     * @virtual
+     */
+    onBeforeWritePage(eventArgs) {
+        // (implemented by child class)
+    }
+    /**
+     * This event occurs after all output files have been written.
+     * @virtual
+     */
+    onFinished(eventArgs) {
+        // (implemented by child class)
+    }
+    static [Symbol.hasInstance](instance) {
+        return node_core_library_1.TypeUuid.isInstanceOf(instance, uuidMarkdownDocumenterFeature);
+    }
+}
+exports.MarkdownDocumenterFeature = MarkdownDocumenterFeature;
+node_core_library_1.TypeUuid.registerClass(MarkdownDocumenterFeature, uuidMarkdownDocumenterFeature);
+//# sourceMappingURL=MarkdownDocumenterFeature.js.map

package/dist/plugin/MarkdownDocumenterFeature.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MarkdownDocumenterFeature.js","sourceRoot":"","sources":["../../src/plugin/MarkdownDocumenterFeature.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;AAMH,oEAAwD;AACxD,mDAAgD;AAGhD;;;;;GAKG;AACH,MAAa,gCAAgC;IAgB3C,gBAAgB;IAChB,YAAmB,OAAyC;QAC1D,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;QACjC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QACzC,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;IACvC,CAAC;CACF;AAtBD,4EAsBC;AA8BD,MAAM,6BAA6B,GACjC,sCAAsC,CAAC;AAEzC;;;;;GAKG;AACH,MAAa,yBAA0B,SAAQ,6BAAa;IAI1D;;;;OAIG;IACI,iBAAiB,CACtB,SAA0D;QAE1D,+BAA+B;IACjC,CAAC;IAED;;;OAGG;IACI,UAAU,CAAC,SAAmD;QACnE,+BAA+B;IACjC,CAAC;IAEM,MAAM,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,QAAgB;QACjD,OAAO,4BAAQ,CAAC,YAAY,CAAC,QAAQ,EAAE,6BAA6B,CAAC,CAAC;IACxE,CAAC;CACF;AA1BD,8DA0BC;AAED,4BAAQ,CAAC,aAAa,CACpB,yBAAyB,EACzB,6BAA6B,CAC9B,CAAC"}