@telefonica/markdown-confluence-sync/dist/lib/docusaurus/tree/DocusaurusDocTreePage.types.d.ts

Creates/updates/deletes Confluence pages based on markdown files in a directory. Supports Mermaid diagrams and per-page configuration using frontmatter metadata. Works great with Docusaurus

import type { LoggerInterface } from "@mocks-server/logger";
import type { DocusaurusDocTreeItem } from "./DocusaurusDocTree.types.js";
import { FilesMetadata } from "../../MarkdownConfluenceSync.types.js";
export interface DocusaurusDocTreePageOptions {
    /** Logger */
    logger?: LoggerInterface;
    /** Files metadata */
    filesMetadata?: FilesMetadata;
}
/** Creates DocusaurusDocTreePage interface */
export interface DocusaurusDocTreePageConstructor {
    /** Returns DocusaurusDocTreePage interface
     *
     * @param {string} path - Path to the page
     * @returns {DocusaurusDocTreePage} instance {@link DocusaurusDocTreePageInterface}.
     * @throws {Error} If the path does not exist.
     * @throws {Error} If the path is not a markdown file.
     */
    new (path: string, options?: DocusaurusDocTreePageOptions): DocusaurusDocTreePageInterface;
}
/**
 * DocusaurusDocTreePage interface
 *
 * @extends DocusaurusDocTreeItem
 */
export type DocusaurusDocTreePageInterface = DocusaurusDocTreeItem;