ts-japi 1.5.1 → 1.6.2

package/tools/internal/custom_markdown_documenter.ts

@@ -0,0 +1,1337 @@
+/**
+ * Copyright 2022 Google Inc. All rights reserved.
+ *
+ * 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
+ *
+ *     https://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.
+ */
+
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the
+// MIT license. See LICENSE in the project root for license information.
+
+// Taken from
+// https://github.com/microsoft/rushstack/blob/main/apps/api-documenter/src/documenters/MarkdownDocumenter.ts
+// This file has been edited to morph into Docusaurus's expected inputs.
+
+import {
+  ApiClass,
+  ApiDeclaredItem,
+  ApiDocumentedItem,
+  ApiEnum,
+  ApiInitializerMixin,
+  ApiInterface,
+  ApiItem,
+  ApiItemKind,
+  ApiModel,
+  ApiNamespace,
+  ApiOptionalMixin,
+  ApiPackage,
+  ApiParameterListMixin,
+  ApiPropertyItem,
+  ApiProtectedMixin,
+  ApiReadonlyMixin,
+  ApiReleaseTagMixin,
+  ApiReturnTypeMixin,
+  ApiStaticMixin,
+  ApiTypeAlias,
+  Excerpt,
+  ExcerptToken,
+  ExcerptTokenKind,
+  IResolveDeclarationReferenceResult,
+  ReleaseTag,
+} from '@microsoft/api-extractor-model';
+import {
+  DocBlock,
+  DocCodeSpan,
+  DocComment,
+  DocFencedCode,
+  DocLinkTag,
+  DocNodeContainer,
+  DocNodeKind,
+  DocParagraph,
+  DocPlainText,
+  DocSection,
+  StandardTags,
+  StringBuilder,
+  TSDocConfiguration,
+} from '@microsoft/tsdoc';
+import { FileSystem, NewlineKind, PackageName } from '@rushstack/node-core-library';
+import * as path from 'path';
+
+import { DocumenterConfig } from '@microsoft/api-documenter/lib/documenters/DocumenterConfig';
+import { CustomMarkdownEmitter } from '@microsoft/api-documenter/lib/markdown/CustomMarkdownEmitter';
+import { CustomDocNodes } from '@microsoft/api-documenter/lib/nodes/CustomDocNodeKind';
+import { DocEmphasisSpan } from '@microsoft/api-documenter/lib/nodes/DocEmphasisSpan';
+import { DocHeading } from '@microsoft/api-documenter/lib/nodes/DocHeading';
+import { DocNoteBox } from '@microsoft/api-documenter/lib/nodes/DocNoteBox';
+import { DocTable } from '@microsoft/api-documenter/lib/nodes/DocTable';
+import { DocTableCell } from '@microsoft/api-documenter/lib/nodes/DocTableCell';
+import { DocTableRow } from '@microsoft/api-documenter/lib/nodes/DocTableRow';
+import { MarkdownDocumenterAccessor } from '@microsoft/api-documenter/lib/plugin/MarkdownDocumenterAccessor';
+import {
+  IMarkdownDocumenterFeatureOnBeforeWritePageArgs,
+  MarkdownDocumenterFeatureContext,
+} from '@microsoft/api-documenter/lib/plugin/MarkdownDocumenterFeature';
+import { PluginLoader } from '@microsoft/api-documenter/lib/plugin/PluginLoader';
+import { Utilities } from '@microsoft/api-documenter/lib/utils/Utilities';
+
+export interface IMarkdownDocumenterOptions {
+  apiModel: ApiModel;
+  documenterConfig: DocumenterConfig | undefined;
+  outputFolder: string;
+}
+
+/**
+ * Renders API documentation in the Markdown file format.
+ * For more info:  https://en.wikipedia.org/wiki/Markdown
+ */
+export class MarkdownDocumenter {
+  private readonly _apiModel: ApiModel;
+  private readonly _documenterConfig: DocumenterConfig | undefined;
+  private readonly _tsdocConfiguration: TSDocConfiguration;
+  private readonly _markdownEmitter: CustomMarkdownEmitter;
+  private readonly _outputFolder: string;
+  private readonly _pluginLoader: PluginLoader;
+
+  public constructor(options: IMarkdownDocumenterOptions) {
+    this._apiModel = options.apiModel;
+    this._documenterConfig = options.documenterConfig;
+    this._outputFolder = options.outputFolder;
+    this._tsdocConfiguration = CustomDocNodes.configuration;
+    this._markdownEmitter = new CustomMarkdownEmitter(this._apiModel);
+
+    this._pluginLoader = new PluginLoader();
+  }
+
+  public generateFiles(): void {
+    if (this._documenterConfig) {
+      this._pluginLoader.load(this._documenterConfig, () => {
+        return new MarkdownDocumenterFeatureContext({
+          apiModel: this._apiModel,
+          outputFolder: this._outputFolder,
+          documenter: new MarkdownDocumenterAccessor({
+            getLinkForApiItem: (apiItem: ApiItem) => {
+              return this._getLinkFilenameForApiItem(apiItem);
+            },
+          }),
+        });
+      });
+    }
+
+    console.log();
+    this._deleteOldOutputFiles();
+
+    this._writeApiItemPage(this._apiModel.members[0]!);
+
+    if (this._pluginLoader.markdownDocumenterFeature) {
+      this._pluginLoader.markdownDocumenterFeature.onFinished({});
+    }
+  }
+
+  private _writeApiItemPage(apiItem: ApiItem): void {
+    const configuration: TSDocConfiguration = this._tsdocConfiguration;
+    const output: DocSection = new DocSection({
+      configuration: this._tsdocConfiguration,
+    });
+
+    const scopedName: string = apiItem.getScopedNameWithinPackage();
+
+    switch (apiItem.kind) {
+      case ApiItemKind.Class:
+        output.appendNode(new DocHeading({ configuration, title: `${scopedName} class` }));
+        break;
+      case ApiItemKind.Enum:
+        output.appendNode(new DocHeading({ configuration, title: `${scopedName} enum` }));
+        break;
+      case ApiItemKind.Interface:
+        output.appendNode(new DocHeading({ configuration, title: `${scopedName} interface` }));
+        break;
+      case ApiItemKind.Constructor:
+      case ApiItemKind.ConstructSignature:
+        output.appendNode(new DocHeading({ configuration, title: scopedName }));
+        break;
+      case ApiItemKind.Method:
+      case ApiItemKind.MethodSignature:
+        output.appendNode(new DocHeading({ configuration, title: `${scopedName} method` }));
+        break;
+      case ApiItemKind.Function:
+        output.appendNode(new DocHeading({ configuration, title: `${scopedName} function` }));
+        break;
+      case ApiItemKind.Model:
+        output.appendNode(new DocHeading({ configuration, title: `API Reference` }));
+        break;
+      case ApiItemKind.Namespace:
+        output.appendNode(new DocHeading({ configuration, title: `${scopedName} namespace` }));
+        break;
+      case ApiItemKind.Package:
+        console.log(`Writing ${apiItem.displayName} package`);
+        output.appendNode(
+          new DocHeading({
+            configuration,
+            title: `API Reference`,
+          })
+        );
+        break;
+      case ApiItemKind.Property:
+      case ApiItemKind.PropertySignature:
+        output.appendNode(new DocHeading({ configuration, title: `${scopedName} property` }));
+        break;
+      case ApiItemKind.TypeAlias:
+        output.appendNode(new DocHeading({ configuration, title: `${scopedName} type` }));
+        break;
+      case ApiItemKind.Variable:
+        output.appendNode(new DocHeading({ configuration, title: `${scopedName} variable` }));
+        break;
+      default:
+        throw new Error('Unsupported API item kind: ' + apiItem.kind);
+    }
+
+    if (ApiReleaseTagMixin.isBaseClassOf(apiItem)) {
+      if (apiItem.releaseTag === ReleaseTag.Beta) {
+        this._writeBetaWarning(output);
+      }
+    }
+
+    const decoratorBlocks: DocBlock[] = [];
+
+    if (apiItem instanceof ApiDocumentedItem) {
+      const tsdocComment: DocComment | undefined = apiItem.tsdocComment;
+
+      if (tsdocComment) {
+        decoratorBlocks.push(
+          ...tsdocComment.customBlocks.filter((block) => {
+            return (
+              block.blockTag.tagNameWithUpperCase === StandardTags.decorator.tagNameWithUpperCase
+            );
+          })
+        );
+
+        if (tsdocComment.deprecatedBlock) {
+          output.appendNode(
+            new DocNoteBox({ configuration: this._tsdocConfiguration }, [
+              new DocParagraph({ configuration: this._tsdocConfiguration }, [
+                new DocPlainText({
+                  configuration: this._tsdocConfiguration,
+                  text: 'Warning: This API is now obsolete. ',
+                }),
+              ]),
+              ...tsdocComment.deprecatedBlock.content.nodes,
+            ])
+          );
+        }
+
+        this._appendSection(output, tsdocComment.summarySection);
+      }
+    }
+
+    if (apiItem instanceof ApiDeclaredItem) {
+      if (apiItem.excerpt.text.length > 0) {
+        output.appendNode(
+          new DocParagraph({ configuration }, [
+            new DocEmphasisSpan({ configuration, bold: true }, [
+              new DocPlainText({ configuration, text: 'Signature:' }),
+            ]),
+          ])
+        );
+
+        let code: string;
+        switch (apiItem.parent?.kind) {
+          case ApiItemKind.Class:
+            code = `class ${apiItem.parent.displayName} {${apiItem.getExcerptWithModifiers()}}`;
+            break;
+          case ApiItemKind.Interface:
+            code = `interface ${apiItem.parent.displayName} {${apiItem.getExcerptWithModifiers()}}`;
+            break;
+          default:
+            code = apiItem.getExcerptWithModifiers();
+        }
+        output.appendNode(
+          new DocFencedCode({
+            configuration,
+            code: code,
+            language: 'typescript',
+          })
+        );
+      }
+
+      this._writeHeritageTypes(output, apiItem);
+    }
+
+    if (decoratorBlocks.length > 0) {
+      output.appendNode(
+        new DocParagraph({ configuration }, [
+          new DocEmphasisSpan({ configuration, bold: true }, [
+            new DocPlainText({ configuration, text: 'Decorators:' }),
+          ]),
+        ])
+      );
+      for (const decoratorBlock of decoratorBlocks) {
+        output.appendNodes(decoratorBlock.content.nodes);
+      }
+    }
+
+    let appendRemarks = true;
+    switch (apiItem.kind) {
+      case ApiItemKind.Class:
+      case ApiItemKind.Interface:
+      case ApiItemKind.Namespace:
+      case ApiItemKind.Package:
+        this._writeRemarksSection(output, apiItem);
+        appendRemarks = false;
+        break;
+    }
+
+    switch (apiItem.kind) {
+      case ApiItemKind.Class:
+        this._writeClassTables(output, apiItem as ApiClass);
+        break;
+      case ApiItemKind.Enum:
+        this._writeEnumTables(output, apiItem as ApiEnum);
+        break;
+      case ApiItemKind.Interface:
+        this._writeInterfaceTables(output, apiItem as ApiInterface);
+        break;
+      case ApiItemKind.Constructor:
+      case ApiItemKind.ConstructSignature:
+      case ApiItemKind.Method:
+      case ApiItemKind.MethodSignature:
+      case ApiItemKind.Function:
+        this._writeParameterTables(output, apiItem as ApiParameterListMixin);
+        this._writeThrowsSection(output, apiItem);
+        break;
+      case ApiItemKind.Namespace:
+        this._writePackageOrNamespaceTables(output, apiItem as ApiNamespace);
+        break;
+      case ApiItemKind.Model:
+        this._writeModelTable(output, apiItem as ApiModel);
+        break;
+      case ApiItemKind.Package:
+        this._writePackageOrNamespaceTables(output, apiItem as ApiPackage);
+        break;
+      case ApiItemKind.Property:
+      case ApiItemKind.PropertySignature:
+        break;
+      case ApiItemKind.TypeAlias:
+        break;
+      case ApiItemKind.Variable:
+        break;
+      default:
+        throw new Error('Unsupported API item kind: ' + apiItem.kind);
+    }
+
+    if (appendRemarks) {
+      this._writeRemarksSection(output, apiItem);
+    }
+
+    const filename: string = path.join(this._outputFolder, this._getFilenameForApiItem(apiItem));
+    const stringBuilder: StringBuilder = new StringBuilder();
+
+    this._markdownEmitter.emit(stringBuilder, output, {
+      contextApiItem: apiItem,
+      onGetFilenameForApiItem: (apiItemForFilename: ApiItem) => {
+        return this._getLinkFilenameForApiItem(apiItemForFilename);
+      },
+    });
+
+    let pageContent: string = stringBuilder.toString();
+
+    if (this._pluginLoader.markdownDocumenterFeature) {
+      // Allow the plugin to customize the pageContent
+      const eventArgs: IMarkdownDocumenterFeatureOnBeforeWritePageArgs = {
+        apiItem: apiItem,
+        outputFilename: filename,
+        pageContent: pageContent,
+      };
+      this._pluginLoader.markdownDocumenterFeature.onBeforeWritePage(eventArgs);
+      pageContent = eventArgs.pageContent;
+    }
+
+    pageContent =
+      `---\nsidebar_label: ${this._getSidebarLabelForApiItem(apiItem)}\n---` + pageContent;
+    pageContent = pageContent.replace('##', '#');
+    pageContent = pageContent.replace(/<!-- -->/g, '');
+    pageContent = pageContent.replace(/<b>|<\/b>/g, '**');
+    FileSystem.writeFile(filename, pageContent, {
+      convertLineEndings: this._documenterConfig
+        ? this._documenterConfig.newlineKind
+        : NewlineKind.CrLf,
+    });
+  }
+
+  private _writeHeritageTypes(output: DocSection, apiItem: ApiDeclaredItem): void {
+    const configuration: TSDocConfiguration = this._tsdocConfiguration;
+
+    if (apiItem instanceof ApiClass) {
+      if (apiItem.extendsType) {
+        const extendsParagraph: DocParagraph = new DocParagraph({ configuration }, [
+          new DocEmphasisSpan({ configuration, bold: true }, [
+            new DocPlainText({ configuration, text: 'Extends: ' }),
+          ]),
+        ]);
+        this._appendExcerptWithHyperlinks(extendsParagraph, apiItem.extendsType.excerpt);
+        output.appendNode(extendsParagraph);
+      }
+      if (apiItem.implementsTypes.length > 0) {
+        const extendsParagraph: DocParagraph = new DocParagraph({ configuration }, [
+          new DocEmphasisSpan({ configuration, bold: true }, [
+            new DocPlainText({ configuration, text: 'Implements: ' }),
+          ]),
+        ]);
+        let needsComma = false;
+        for (const implementsType of apiItem.implementsTypes) {
+          if (needsComma) {
+            extendsParagraph.appendNode(new DocPlainText({ configuration, text: ', ' }));
+          }
+          this._appendExcerptWithHyperlinks(extendsParagraph, implementsType.excerpt);
+          needsComma = true;
+        }
+        output.appendNode(extendsParagraph);
+      }
+    }
+
+    if (apiItem instanceof ApiInterface) {
+      if (apiItem.extendsTypes.length > 0) {
+        const extendsParagraph: DocParagraph = new DocParagraph({ configuration }, [
+          new DocEmphasisSpan({ configuration, bold: true }, [
+            new DocPlainText({ configuration, text: 'Extends: ' }),
+          ]),
+        ]);
+        let needsComma = false;
+        for (const extendsType of apiItem.extendsTypes) {
+          if (needsComma) {
+            extendsParagraph.appendNode(new DocPlainText({ configuration, text: ', ' }));
+          }
+          this._appendExcerptWithHyperlinks(extendsParagraph, extendsType.excerpt);
+          needsComma = true;
+        }
+        output.appendNode(extendsParagraph);
+      }
+    }
+
+    if (apiItem instanceof ApiTypeAlias) {
+      const refs: ExcerptToken[] = apiItem.excerptTokens.filter((token) => {
+        return (
+          token.kind === ExcerptTokenKind.Reference &&
+          token.canonicalReference &&
+          this._apiModel.resolveDeclarationReference(token.canonicalReference, undefined)
+            .resolvedApiItem
+        );
+      });
+      if (refs.length > 0) {
+        const referencesParagraph: DocParagraph = new DocParagraph({ configuration }, [
+          new DocEmphasisSpan({ configuration, bold: true }, [
+            new DocPlainText({ configuration, text: 'References: ' }),
+          ]),
+        ]);
+        let needsComma = false;
+        const visited: Set<string> = new Set();
+        for (const ref of refs) {
+          if (visited.has(ref.text)) {
+            continue;
+          }
+          visited.add(ref.text);
+
+          if (needsComma) {
+            referencesParagraph.appendNode(new DocPlainText({ configuration, text: ', ' }));
+          }
+
+          this._appendExcerptTokenWithHyperlinks(referencesParagraph, ref);
+          needsComma = true;
+        }
+        output.appendNode(referencesParagraph);
+      }
+    }
+  }
+
+  private _writeRemarksSection(output: DocSection, apiItem: ApiItem): void {
+    if (apiItem instanceof ApiDocumentedItem) {
+      const tsdocComment: DocComment | undefined = apiItem.tsdocComment;
+
+      if (tsdocComment) {
+        // Write the @remarks block
+        if (tsdocComment.remarksBlock) {
+          output.appendNode(
+            new DocHeading({
+              configuration: this._tsdocConfiguration,
+              title: 'Remarks',
+            })
+          );
+          this._appendSection(output, tsdocComment.remarksBlock.content);
+        }
+
+        // Write the @example blocks
+        const exampleBlocks: DocBlock[] = tsdocComment.customBlocks.filter((x) => {
+          return x.blockTag.tagNameWithUpperCase === StandardTags.example.tagNameWithUpperCase;
+        });
+
+        let exampleNumber = 1;
+        for (const exampleBlock of exampleBlocks) {
+          const heading: string = exampleBlocks.length > 1 ? `Example ${exampleNumber}` : 'Example';
+
+          output.appendNode(
+            new DocHeading({
+              configuration: this._tsdocConfiguration,
+              title: heading,
+            })
+          );
+
+          this._appendSection(output, exampleBlock.content);
+
+          ++exampleNumber;
+        }
+      }
+    }
+  }
+
+  private _writeThrowsSection(output: DocSection, apiItem: ApiItem): void {
+    if (apiItem instanceof ApiDocumentedItem) {
+      const tsdocComment: DocComment | undefined = apiItem.tsdocComment;
+
+      if (tsdocComment) {
+        // Write the @throws blocks
+        const throwsBlocks: DocBlock[] = tsdocComment.customBlocks.filter((x) => {
+          return x.blockTag.tagNameWithUpperCase === StandardTags.throws.tagNameWithUpperCase;
+        });
+
+        if (throwsBlocks.length > 0) {
+          const heading = 'Exceptions';
+          output.appendNode(
+            new DocHeading({
+              configuration: this._tsdocConfiguration,
+              title: heading,
+            })
+          );
+
+          for (const throwsBlock of throwsBlocks) {
+            this._appendSection(output, throwsBlock.content);
+          }
+        }
+      }
+    }
+  }
+
+  /**
+   * GENERATE PAGE: MODEL
+   */
+  private _writeModelTable(output: DocSection, apiModel: ApiModel): void {
+    const configuration: TSDocConfiguration = this._tsdocConfiguration;
+
+    const packagesTable: DocTable = new DocTable({
+      configuration,
+      headerTitles: ['Package', 'Description'],
+    });
+
+    for (const apiMember of apiModel.members) {
+      const row: DocTableRow = new DocTableRow({ configuration }, [
+        this._createTitleCell(apiMember),
+        this._createDescriptionCell(apiMember),
+      ]);
+
+      switch (apiMember.kind) {
+        case ApiItemKind.Package:
+          packagesTable.addRow(row);
+          this._writeApiItemPage(apiMember);
+          break;
+      }
+    }
+
+    if (packagesTable.rows.length > 0) {
+      output.appendNode(
+        new DocHeading({
+          configuration: this._tsdocConfiguration,
+          title: 'Packages',
+        })
+      );
+      output.appendNode(packagesTable);
+    }
+  }
+
+  /**
+   * GENERATE PAGE: PACKAGE or NAMESPACE
+   */
+  private _writePackageOrNamespaceTables(
+    output: DocSection,
+    apiContainer: ApiPackage | ApiNamespace
+  ): void {
+    const configuration: TSDocConfiguration = this._tsdocConfiguration;
+
+    const classesTable: DocTable = new DocTable({
+      configuration,
+      headerTitles: ['Class', 'Description'],
+    });
+
+    const enumerationsTable: DocTable = new DocTable({
+      configuration,
+      headerTitles: ['Enumeration', 'Description'],
+    });
+
+    const functionsTable: DocTable = new DocTable({
+      configuration,
+      headerTitles: ['Function', 'Description'],
+    });
+
+    const interfacesTable: DocTable = new DocTable({
+      configuration,
+      headerTitles: ['Interface', 'Description'],
+    });
+
+    const namespacesTable: DocTable = new DocTable({
+      configuration,
+      headerTitles: ['Namespace', 'Description'],
+    });
+
+    const variablesTable: DocTable = new DocTable({
+      configuration,
+      headerTitles: ['Variable', 'Description'],
+    });
+
+    const typeAliasesTable: DocTable = new DocTable({
+      configuration,
+      headerTitles: ['Type Alias', 'Description'],
+    });
+
+    const apiMembers: ReadonlyArray<ApiItem> =
+      apiContainer.kind === ApiItemKind.Package
+        ? (apiContainer as ApiPackage).entryPoints[0]!.members
+        : (apiContainer as ApiNamespace).members;
+
+    for (const apiMember of apiMembers) {
+      const row: DocTableRow = new DocTableRow({ configuration }, [
+        this._createTitleCell(apiMember),
+        this._createDescriptionCell(apiMember),
+      ]);
+
+      switch (apiMember.kind) {
+        case ApiItemKind.Class:
+          classesTable.addRow(row);
+          this._writeApiItemPage(apiMember);
+          break;
+
+        case ApiItemKind.Enum:
+          enumerationsTable.addRow(row);
+          this._writeApiItemPage(apiMember);
+          break;
+
+        case ApiItemKind.Interface:
+          interfacesTable.addRow(row);
+          this._writeApiItemPage(apiMember);
+          break;
+
+        case ApiItemKind.Namespace:
+          namespacesTable.addRow(row);
+          this._writeApiItemPage(apiMember);
+          break;
+
+        case ApiItemKind.Function:
+          functionsTable.addRow(row);
+          this._writeApiItemPage(apiMember);
+          break;
+
+        case ApiItemKind.TypeAlias:
+          typeAliasesTable.addRow(row);
+          this._writeApiItemPage(apiMember);
+          break;
+
+        case ApiItemKind.Variable:
+          variablesTable.addRow(row);
+          this._writeApiItemPage(apiMember);
+          break;
+      }
+    }
+
+    if (classesTable.rows.length > 0) {
+      output.appendNode(
+        new DocHeading({
+          configuration: this._tsdocConfiguration,
+          title: 'Classes',
+        })
+      );
+      output.appendNode(classesTable);
+    }
+
+    if (enumerationsTable.rows.length > 0) {
+      output.appendNode(
+        new DocHeading({
+          configuration: this._tsdocConfiguration,
+          title: 'Enumerations',
+        })
+      );
+      output.appendNode(enumerationsTable);
+    }
+    if (functionsTable.rows.length > 0) {
+      output.appendNode(
+        new DocHeading({
+          configuration: this._tsdocConfiguration,
+          title: 'Functions',
+        })
+      );
+      output.appendNode(functionsTable);
+    }
+
+    if (interfacesTable.rows.length > 0) {
+      output.appendNode(
+        new DocHeading({
+          configuration: this._tsdocConfiguration,
+          title: 'Interfaces',
+        })
+      );
+      output.appendNode(interfacesTable);
+    }
+
+    if (namespacesTable.rows.length > 0) {
+      output.appendNode(
+        new DocHeading({
+          configuration: this._tsdocConfiguration,
+          title: 'Namespaces',
+        })
+      );
+      output.appendNode(namespacesTable);
+    }
+
+    if (variablesTable.rows.length > 0) {
+      output.appendNode(
+        new DocHeading({
+          configuration: this._tsdocConfiguration,
+          title: 'Variables',
+        })
+      );
+      output.appendNode(variablesTable);
+    }
+
+    if (typeAliasesTable.rows.length > 0) {
+      output.appendNode(
+        new DocHeading({
+          configuration: this._tsdocConfiguration,
+          title: 'Type Aliases',
+        })
+      );
+      output.appendNode(typeAliasesTable);
+    }
+  }
+
+  /**
+   * GENERATE PAGE: CLASS
+   */
+  private _writeClassTables(output: DocSection, apiClass: ApiClass): void {
+    const configuration: TSDocConfiguration = this._tsdocConfiguration;
+
+    const eventsTable: DocTable = new DocTable({
+      configuration,
+      headerTitles: ['Property', 'Modifiers', 'Type', 'Description'],
+    });
+
+    const constructorsTable: DocTable = new DocTable({
+      configuration,
+      headerTitles: ['Constructor', 'Modifiers', 'Description'],
+    });
+
+    const propertiesTable: DocTable = new DocTable({
+      configuration,
+      headerTitles: ['Property', 'Modifiers', 'Type', 'Description'],
+    });
+
+    const methodsTable: DocTable = new DocTable({
+      configuration,
+      headerTitles: ['Method', 'Modifiers', 'Description'],
+    });
+
+    for (const apiMember of apiClass.members) {
+      switch (apiMember.kind) {
+        case ApiItemKind.Constructor: {
+          constructorsTable.addRow(
+            new DocTableRow({ configuration }, [
+              this._createTitleCell(apiMember),
+              this._createModifiersCell(apiMember),
+              this._createDescriptionCell(apiMember),
+            ])
+          );
+
+          this._writeApiItemPage(apiMember);
+          break;
+        }
+        case ApiItemKind.Method: {
+          methodsTable.addRow(
+            new DocTableRow({ configuration }, [
+              this._createTitleCell(apiMember),
+              this._createModifiersCell(apiMember),
+              this._createDescriptionCell(apiMember),
+            ])
+          );
+
+          this._writeApiItemPage(apiMember);
+          break;
+        }
+        case ApiItemKind.Property: {
+          if ((apiMember as ApiPropertyItem).isEventProperty) {
+            eventsTable.addRow(
+              new DocTableRow({ configuration }, [
+                this._createTitleCell(apiMember),
+                this._createModifiersCell(apiMember),
+                this._createPropertyTypeCell(apiMember),
+                this._createDescriptionCell(apiMember),
+              ])
+            );
+          } else {
+            propertiesTable.addRow(
+              new DocTableRow({ configuration }, [
+                this._createTitleCell(apiMember),
+                this._createModifiersCell(apiMember),
+                this._createPropertyTypeCell(apiMember),
+                this._createDescriptionCell(apiMember),
+              ])
+            );
+          }
+
+          this._writeApiItemPage(apiMember);
+          break;
+        }
+      }
+    }
+
+    if (eventsTable.rows.length > 0) {
+      output.appendNode(
+        new DocHeading({
+          configuration: this._tsdocConfiguration,
+          title: 'Events',
+        })
+      );
+      output.appendNode(eventsTable);
+    }
+
+    if (constructorsTable.rows.length > 0) {
+      output.appendNode(
+        new DocHeading({
+          configuration: this._tsdocConfiguration,
+          title: 'Constructors',
+        })
+      );
+      output.appendNode(constructorsTable);
+    }
+
+    if (propertiesTable.rows.length > 0) {
+      output.appendNode(
+        new DocHeading({
+          configuration: this._tsdocConfiguration,
+          title: 'Properties',
+        })
+      );
+      output.appendNode(propertiesTable);
+    }
+
+    if (methodsTable.rows.length > 0) {
+      output.appendNode(
+        new DocHeading({
+          configuration: this._tsdocConfiguration,
+          title: 'Methods',
+        })
+      );
+      output.appendNode(methodsTable);
+    }
+  }
+
+  /**
+   * GENERATE PAGE: ENUM
+   */
+  private _writeEnumTables(output: DocSection, apiEnum: ApiEnum): void {
+    const configuration: TSDocConfiguration = this._tsdocConfiguration;
+
+    const enumMembersTable: DocTable = new DocTable({
+      configuration,
+      headerTitles: ['Member', 'Value', 'Description'],
+    });
+
+    for (const apiEnumMember of apiEnum.members) {
+      enumMembersTable.addRow(
+        new DocTableRow({ configuration }, [
+          new DocTableCell({ configuration }, [
+            new DocParagraph({ configuration }, [
+              new DocPlainText({
+                configuration,
+                text: Utilities.getConciseSignature(apiEnumMember),
+              }),
+            ]),
+          ]),
+          this._createInitializerCell(apiEnumMember),
+          this._createDescriptionCell(apiEnumMember),
+        ])
+      );
+    }
+
+    if (enumMembersTable.rows.length > 0) {
+      output.appendNode(
+        new DocHeading({
+          configuration: this._tsdocConfiguration,
+          title: 'Enumeration Members',
+        })
+      );
+      output.appendNode(enumMembersTable);
+    }
+  }
+
+  /**
+   * GENERATE PAGE: INTERFACE
+   */
+  private _writeInterfaceTables(output: DocSection, apiClass: ApiInterface): void {
+    const configuration: TSDocConfiguration = this._tsdocConfiguration;
+
+    const eventsTable: DocTable = new DocTable({
+      configuration,
+      headerTitles: ['Property', 'Modifiers', 'Type', 'Description'],
+    });
+
+    const propertiesTable: DocTable = new DocTable({
+      configuration,
+      headerTitles: ['Property', 'Modifiers', 'Type', 'Description'],
+    });
+
+    const methodsTable: DocTable = new DocTable({
+      configuration,
+      headerTitles: ['Method', 'Description'],
+    });
+
+    for (const apiMember of apiClass.members) {
+      switch (apiMember.kind) {
+        case ApiItemKind.ConstructSignature:
+        case ApiItemKind.MethodSignature: {
+          methodsTable.addRow(
+            new DocTableRow({ configuration }, [
+              this._createTitleCell(apiMember),
+              this._createDescriptionCell(apiMember),
+            ])
+          );
+
+          this._writeApiItemPage(apiMember);
+          break;
+        }
+        case ApiItemKind.PropertySignature: {
+          if ((apiMember as ApiPropertyItem).isEventProperty) {
+            eventsTable.addRow(
+              new DocTableRow({ configuration }, [
+                this._createTitleCell(apiMember),
+                this._createModifiersCell(apiMember),
+                this._createPropertyTypeCell(apiMember),
+                this._createDescriptionCell(apiMember),
+              ])
+            );
+          } else {
+            propertiesTable.addRow(
+              new DocTableRow({ configuration }, [
+                this._createTitleCell(apiMember),
+                this._createModifiersCell(apiMember),
+                this._createPropertyTypeCell(apiMember),
+                this._createDescriptionCell(apiMember),
+              ])
+            );
+          }
+
+          this._writeApiItemPage(apiMember);
+          break;
+        }
+      }
+    }
+
+    if (eventsTable.rows.length > 0) {
+      output.appendNode(
+        new DocHeading({
+          configuration: this._tsdocConfiguration,
+          title: 'Events',
+        })
+      );
+      output.appendNode(eventsTable);
+    }
+
+    if (propertiesTable.rows.length > 0) {
+      output.appendNode(
+        new DocHeading({
+          configuration: this._tsdocConfiguration,
+          title: 'Properties',
+        })
+      );
+      output.appendNode(propertiesTable);
+    }
+
+    if (methodsTable.rows.length > 0) {
+      output.appendNode(
+        new DocHeading({
+          configuration: this._tsdocConfiguration,
+          title: 'Methods',
+        })
+      );
+      output.appendNode(methodsTable);
+    }
+  }
+
+  /**
+   * GENERATE PAGE: FUNCTION-LIKE
+   */
+  private _writeParameterTables(
+    output: DocSection,
+    apiParameterListMixin: ApiParameterListMixin
+  ): void {
+    const configuration: TSDocConfiguration = this._tsdocConfiguration;
+
+    const parametersTable: DocTable = new DocTable({
+      configuration,
+      headerTitles: ['Parameter', 'Type', 'Description'],
+    });
+    for (const apiParameter of apiParameterListMixin.parameters) {
+      const parameterDescription: DocSection = new DocSection({ configuration });
+
+      if (apiParameter.isOptional) {
+        parameterDescription.appendNodesInParagraph([
+          new DocEmphasisSpan({ configuration, italic: true }, [
+            new DocPlainText({ configuration, text: '(Optional)' }),
+          ]),
+          new DocPlainText({ configuration, text: ' ' }),
+        ]);
+      }
+
+      if (apiParameter.tsdocParamBlock) {
+        this._appendAndMergeSection(parameterDescription, apiParameter.tsdocParamBlock.content);
+      }
+
+      parametersTable.addRow(
+        new DocTableRow({ configuration }, [
+          new DocTableCell({ configuration }, [
+            new DocParagraph({ configuration }, [
+              new DocPlainText({ configuration, text: apiParameter.name }),
+            ]),
+          ]),
+          new DocTableCell({ configuration }, [
+            this._createParagraphForTypeExcerpt(apiParameter.parameterTypeExcerpt),
+          ]),
+          new DocTableCell({ configuration }, parameterDescription.nodes),
+        ])
+      );
+    }
+
+    if (parametersTable.rows.length > 0) {
+      output.appendNode(
+        new DocHeading({
+          configuration: this._tsdocConfiguration,
+          title: 'Parameters',
+        })
+      );
+      output.appendNode(parametersTable);
+    }
+
+    if (ApiReturnTypeMixin.isBaseClassOf(apiParameterListMixin)) {
+      const returnTypeExcerpt: Excerpt = apiParameterListMixin.returnTypeExcerpt;
+      output.appendNode(
+        new DocParagraph({ configuration }, [
+          new DocEmphasisSpan({ configuration, bold: true }, [
+            new DocPlainText({ configuration, text: 'Returns:' }),
+          ]),
+        ])
+      );
+
+      output.appendNode(this._createParagraphForTypeExcerpt(returnTypeExcerpt));
+
+      if (apiParameterListMixin instanceof ApiDocumentedItem) {
+        if (apiParameterListMixin.tsdocComment && apiParameterListMixin.tsdocComment.returnsBlock) {
+          this._appendSection(output, apiParameterListMixin.tsdocComment.returnsBlock.content);
+        }
+      }
+    }
+  }
+
+  private _createParagraphForTypeExcerpt(excerpt: Excerpt): DocParagraph {
+    const configuration: TSDocConfiguration = this._tsdocConfiguration;
+
+    const paragraph: DocParagraph = new DocParagraph({ configuration });
+    if (!excerpt.text.trim()) {
+      paragraph.appendNode(new DocPlainText({ configuration, text: '(not declared)' }));
+    } else {
+      this._appendExcerptWithHyperlinks(paragraph, excerpt);
+    }
+
+    return paragraph;
+  }
+
+  private _appendExcerptWithHyperlinks(docNodeContainer: DocNodeContainer, excerpt: Excerpt): void {
+    for (const token of excerpt.spannedTokens) {
+      this._appendExcerptTokenWithHyperlinks(docNodeContainer, token);
+    }
+  }
+
+  private _appendExcerptTokenWithHyperlinks(
+    docNodeContainer: DocNodeContainer,
+    token: ExcerptToken
+  ): void {
+    const configuration: TSDocConfiguration = this._tsdocConfiguration;
+
+    // Markdown doesn't provide a standardized syntax for hyperlinks inside code
+    // spans, so we will render the type expression as DocPlainText.  Instead of
+    // creating multiple DocParagraphs, we can simply discard any newlines and
+    // let the renderer do normal word-wrapping.
+    const unwrappedTokenText: string = token.text.replace(/[\r\n]+/g, ' ');
+
+    // If it's hyperlinkable, then append a DocLinkTag
+    if (token.kind === ExcerptTokenKind.Reference && token.canonicalReference) {
+      const apiItemResult: IResolveDeclarationReferenceResult =
+        this._apiModel.resolveDeclarationReference(token.canonicalReference, undefined);
+
+      if (apiItemResult.resolvedApiItem) {
+        docNodeContainer.appendNode(
+          new DocLinkTag({
+            configuration,
+            tagName: '@link',
+            linkText: unwrappedTokenText,
+            urlDestination: this._getLinkFilenameForApiItem(apiItemResult.resolvedApiItem),
+          })
+        );
+        return;
+      }
+    }
+
+    // Otherwise append non-hyperlinked text
+    docNodeContainer.appendNode(new DocPlainText({ configuration, text: unwrappedTokenText }));
+  }
+
+  private _createTitleCell(apiItem: ApiItem): DocTableCell {
+    const configuration: TSDocConfiguration = this._tsdocConfiguration;
+
+    let linkText: string = Utilities.getConciseSignature(apiItem);
+    if (ApiOptionalMixin.isBaseClassOf(apiItem) && apiItem.isOptional) {
+      linkText += '?';
+    }
+
+    return new DocTableCell({ configuration }, [
+      new DocParagraph({ configuration }, [
+        new DocLinkTag({
+          configuration,
+          tagName: '@link',
+          linkText: linkText,
+          urlDestination: this._getLinkFilenameForApiItem(apiItem),
+        }),
+      ]),
+    ]);
+  }
+
+  /**
+   * This generates a DocTableCell for an ApiItem including the summary section
+   * and "(BETA)" annotation.
+   *
+   * @remarks
+   * We mostly assume that the input is an ApiDocumentedItem, but it's easier to
+   * perform this as a runtime check than to have each caller perform a type
+   * cast.
+   */
+  private _createDescriptionCell(apiItem: ApiItem): DocTableCell {
+    const configuration: TSDocConfiguration = this._tsdocConfiguration;
+
+    const section: DocSection = new DocSection({ configuration });
+
+    if (ApiReleaseTagMixin.isBaseClassOf(apiItem)) {
+      if (apiItem.releaseTag === ReleaseTag.Beta) {
+        section.appendNodesInParagraph([
+          new DocEmphasisSpan({ configuration, bold: true, italic: true }, [
+            new DocPlainText({ configuration, text: '(BETA)' }),
+          ]),
+          new DocPlainText({ configuration, text: ' ' }),
+        ]);
+      }
+    }
+
+    if (ApiOptionalMixin.isBaseClassOf(apiItem) && apiItem.isOptional) {
+      section.appendNodesInParagraph([
+        new DocEmphasisSpan({ configuration, italic: true }, [
+          new DocPlainText({ configuration, text: '(Optional)' }),
+        ]),
+        new DocPlainText({ configuration, text: ' ' }),
+      ]);
+    }
+
+    if (apiItem instanceof ApiDocumentedItem) {
+      if (apiItem.tsdocComment !== undefined) {
+        this._appendAndMergeSection(section, apiItem.tsdocComment.summarySection);
+      }
+    }
+
+    return new DocTableCell({ configuration }, section.nodes);
+  }
+
+  private _createModifiersCell(apiItem: ApiItem): DocTableCell {
+    const configuration: TSDocConfiguration = this._tsdocConfiguration;
+
+    const section: DocSection = new DocSection({ configuration });
+
+    if (ApiProtectedMixin.isBaseClassOf(apiItem)) {
+      if (apiItem.isProtected) {
+        section.appendNode(
+          new DocParagraph({ configuration }, [
+            new DocCodeSpan({ configuration, code: 'protected' }),
+          ])
+        );
+      }
+    }
+
+    if (ApiReadonlyMixin.isBaseClassOf(apiItem)) {
+      if (apiItem.isReadonly) {
+        section.appendNode(
+          new DocParagraph({ configuration }, [
+            new DocCodeSpan({ configuration, code: 'readonly' }),
+          ])
+        );
+      }
+    }
+
+    if (ApiStaticMixin.isBaseClassOf(apiItem)) {
+      if (apiItem.isStatic) {
+        section.appendNode(
+          new DocParagraph({ configuration }, [new DocCodeSpan({ configuration, code: 'static' })])
+        );
+      }
+    }
+
+    return new DocTableCell({ configuration }, section.nodes);
+  }
+
+  private _createPropertyTypeCell(apiItem: ApiItem): DocTableCell {
+    const configuration: TSDocConfiguration = this._tsdocConfiguration;
+
+    const section: DocSection = new DocSection({ configuration });
+
+    if (apiItem instanceof ApiPropertyItem) {
+      section.appendNode(this._createParagraphForTypeExcerpt(apiItem.propertyTypeExcerpt));
+    }
+
+    return new DocTableCell({ configuration }, section.nodes);
+  }
+
+  private _createInitializerCell(apiItem: ApiItem): DocTableCell {
+    const configuration: TSDocConfiguration = this._tsdocConfiguration;
+
+    const section: DocSection = new DocSection({ configuration });
+
+    if (ApiInitializerMixin.isBaseClassOf(apiItem)) {
+      if (apiItem.initializerExcerpt) {
+        section.appendNodeInParagraph(
+          new DocCodeSpan({
+            configuration,
+            code: apiItem.initializerExcerpt.text,
+          })
+        );
+      }
+    }
+
+    return new DocTableCell({ configuration }, section.nodes);
+  }
+
+  private _writeBetaWarning(output: DocSection): void {
+    const configuration: TSDocConfiguration = this._tsdocConfiguration;
+    const betaWarning: string =
+      'This API is provided as a preview for developers and may change' +
+      ' based on feedback that we receive.  Do not use this API in a production environment.';
+    output.appendNode(
+      new DocNoteBox({ configuration }, [
+        new DocParagraph({ configuration }, [
+          new DocPlainText({ configuration, text: betaWarning }),
+        ]),
+      ])
+    );
+  }
+
+  private _appendSection(output: DocSection, docSection: DocSection): void {
+    for (const node of docSection.nodes) {
+      output.appendNode(node);
+    }
+  }
+
+  private _appendAndMergeSection(output: DocSection, docSection: DocSection): void {
+    let firstNode = true;
+    for (const node of docSection.nodes) {
+      if (firstNode) {
+        if (node.kind === DocNodeKind.Paragraph) {
+          output.appendNodesInParagraph(node.getChildNodes());
+          firstNode = false;
+          continue;
+        }
+      }
+      firstNode = false;
+
+      output.appendNode(node);
+    }
+  }
+
+  private _getSidebarLabelForApiItem(apiItem: ApiItem): string {
+    if (apiItem.kind === ApiItemKind.Package) {
+      return 'API';
+    }
+
+    let baseName = '';
+    for (const hierarchyItem of apiItem.getHierarchy()) {
+      // For overloaded methods, add a suffix such as "MyClass.myMethod_2".
+      let qualifiedName: string = hierarchyItem.displayName;
+      if (ApiParameterListMixin.isBaseClassOf(hierarchyItem)) {
+        if (hierarchyItem.overloadIndex > 1) {
+          // Subtract one for compatibility with earlier releases of API Documenter.
+          // (This will get revamped when we fix GitHub issue #1308)
+          qualifiedName += `_${hierarchyItem.overloadIndex - 1}`;
+        }
+      }
+
+      switch (hierarchyItem.kind) {
+        case ApiItemKind.Model:
+        case ApiItemKind.EntryPoint:
+        case ApiItemKind.EnumMember:
+        case ApiItemKind.Package:
+          break;
+        default:
+          baseName += qualifiedName + '.';
+      }
+    }
+    return baseName.slice(0, baseName.length - 1);
+  }
+
+  private _getFilenameForApiItem(apiItem: ApiItem): string {
+    if (apiItem.kind === ApiItemKind.Package) {
+      return 'index.md';
+    }
+
+    let baseName = '';
+    for (const hierarchyItem of apiItem.getHierarchy()) {
+      // For overloaded methods, add a suffix such as "MyClass.myMethod_2".
+      let qualifiedName: string = Utilities.getSafeFilenameForName(hierarchyItem.displayName);
+      if (ApiParameterListMixin.isBaseClassOf(hierarchyItem)) {
+        if (hierarchyItem.overloadIndex > 1) {
+          // Subtract one for compatibility with earlier releases of API Documenter.
+          // (This will get revamped when we fix GitHub issue #1308)
+          qualifiedName += `_${hierarchyItem.overloadIndex - 1}`;
+        }
+      }
+
+      switch (hierarchyItem.kind) {
+        case ApiItemKind.Model:
+        case ApiItemKind.EntryPoint:
+        case ApiItemKind.EnumMember:
+          break;
+        case ApiItemKind.Package:
+          baseName = Utilities.getSafeFilenameForName(
+            PackageName.getUnscopedName(hierarchyItem.displayName)
+          );
+          break;
+        default:
+          baseName += '.' + qualifiedName;
+      }
+    }
+    return baseName + '.md';
+  }
+
+  private _getLinkFilenameForApiItem(apiItem: ApiItem): string {
+    return './' + this._getFilenameForApiItem(apiItem);
+  }
+
+  private _deleteOldOutputFiles(): void {
+    console.log('Deleting old output from ' + this._outputFolder);
+    FileSystem.ensureEmptyFolder(this._outputFolder);
+  }
+}