@telefonica/markdown-confluence-sync
Version:
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
22 lines (21 loc) • 962 B
TypeScript
import type { FilesPattern } from "../MarkdownConfluenceSync.types";
import { SyncModes } from "@telefonica/confluence-sync";
import type { MarkdownDocumentsInterface, MarkdownDocumentsModeOptions } from "./DocusaurusPages.types";
export interface MarkdownFlatDocumentsOptions extends MarkdownDocumentsModeOptions {
/** Pattern to search files when flat mode is active */
filesPattern?: FilesPattern;
/** Pattern with files to be ignored */
filesIgnore?: FilesPattern;
/** Working directory */
cwd: string;
/** Mode */
mode: SyncModes.FLAT | SyncModes.ID;
}
/** Creates a MarkdownFlatDocuments interface */
export interface MarkdownFlatDocumentsConstructor {
/** Returns MarkdownFlatDocuments interface
* @param {MarkdownFlatDocumentsOptions} options
* @returns MarkdownFlatDocuments instance {@link MarkdownDocumentsInterface}.
*/
new (options: MarkdownFlatDocumentsOptions): MarkdownDocumentsInterface;
}