/*! * Copyright (c) Microsoft Corporation and contributors. All rights reserved. * Licensed under the MIT License. */ /** * Contains a programmatic API for generating {@link https://en.wikipedia.org/wiki/Markdown | Markdown} documentation * from an API report generated by {@link https://api-extractor.com/ | API-Extractor}. * * @remarks Akin to {@link https://github.com/microsoft/rushstack/tree/main/apps/api-documenter | API-Documenter} and * is heavily based upon it, but is designed to be more extensible and to be be used programmatically. * * @packageDocumentation */ export { type ApiItemTransformationConfiguration, type ApiItemTransformationConfigurationBase, type ApiItemTransformationOptions, type ApiItemTransformations, type DefaultDocumentationSuiteConfiguration, type DocumentationHierarchyConfiguration, type DocumentationHierarchyConfigurationBase, type DocumentationSuiteConfiguration, type DocumentationSuiteOptions, type DocumentHierarchyConfiguration, FolderDocumentPlacement, type FolderHierarchyConfiguration, // TODO: remove this once utility APIs can be called with partial configs. getApiItemTransformationConfigurationWithDefaults, HierarchyKind, type HierarchyConfiguration, type HierarchyOptions, type SectionHierarchyConfiguration, type TransformApiItemWithChildren, type TransformApiItemWithoutChildren, transformApiModel, transformTsdoc, } from "./api-item-transforms/index.js"; export type { ApiDocument, RenderedDocument } from "./ApiDocument.js"; export type { NormalizedRootContent, NormalizedTree, Section, SectionContent, SectionHeading, } from "./mdast/index.js"; export { DocumentWriter, type RenderMarkdownConfiguration, } from "./renderers/index.js"; export type { LoggingConfiguration } from "./LoggingConfiguration.js"; export { type SaveDocumentsOptions, saveDocuments } from "./FileSystem.js"; export { lintApiModel, type LintApiModelConfiguration, type LinterErrors, type LinterReferenceError, } from "./LintApiModel.js"; export { loadModel, type LoadModelOptions } from "./LoadModel.js"; export { defaultConsoleLogger, type LoggingFunction, type Logger, verboseConsoleLogger, } from "./Logging.js"; export type { ApiConstructorLike, ApiFunctionLike, ApiMemberKind, ApiModifier, ApiModuleLike, ApiSignatureLike, ApiTypeLike, ReleaseLevel, ValidApiItemKind, } from "./utilities/index.js"; // #region Scoped exports // This pattern is required to scope the utilities in a way that API-Extractor supports. /* eslint-disable import-x/order, unicorn/prefer-export-from */ // Export `ApiItem`-related utilities import * as ApiItemUtilities from "./ApiItemUtilitiesModule.js"; // Export layout-related utilities (for use in writing custom transformations) import * as LayoutUtilities from "./LayoutUtilitiesModule.js"; // Export renderers import * as MarkdownRenderer from "./MarkdownRendererModule.js"; export { /** * Utilities for use with `ApiItem`s. * * @remarks * * These are intended to be useful when injecting custom `ApiItem` transformation behaviors via {@link ApiItemTransformationConfiguration}. * * @public */ ApiItemUtilities, /** * Utilities related to generating Markdown content for {@link @microsoft/api-extractor-model#ApiItem}s. * * @remarks * * These are intended to be useful when injecting custom `ApiItem` transformation behaviors via {@link ApiItemTransformationConfiguration}. * * @public */ LayoutUtilities, /** * Functionality for rendering documentation as Markdown. * * @public */ MarkdownRenderer, }; /* eslint-enable import-x/order, unicorn/prefer-export-from */ // #endregion // #region Convenience re-exports // Convenience re-exports export { type ApiItem, ApiItemKind, type ApiModel, type ApiPackage, ReleaseTag, } from "@microsoft/api-extractor-model"; export { NewlineKind } from "@rushstack/node-core-library";