@telefonica/markdown-confluence-sync/dist/lib/docusaurus/util/files.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 { VFile } from "vfile";
import type { GetIndexFileOptions } from "./files.types.js";
import { ContentPreprocessor } from "../../MarkdownConfluenceSync.types.js";
/**
 * Checked if file is valid in docusaurus
 * @param path - Page path
 * @returns {boolean}
 */
export declare function isValidFile(path: string): boolean;
/**
 * Check if file ended with md or mdx
 * @param path - Page path
 * @returns {boolean}
 */
export declare function isSupportedFile(path: string): boolean;
/**
 * Check if file is not an index file
 * index files are the following:
 * - index.md
 * - index.mdx
 * - README.md
 * - README.mdx
 * - [directory-name].md
 * - [directory-name].mdx
 * @param path - Page path
 * @returns {boolean}
 */
export declare function isNotIndexFile(path: string): boolean;
/**
 * Replace docusaurus admonitions titles to a valid remark-directive
 * @param {string} path - Path to the docs directory
 * @param options - Options with {LoggerInterface} logger
 * @returns {VFile} - File
 */
export declare function readMarkdownAndPatchDocusaurusAdmonitions(path: string, options?: {
    logger?: LoggerInterface;
    contentPreprocessor?: ContentPreprocessor;
}): VFile;
/**
 * Search for index file in the path
 * @param {string} path - Path to the docs directory
 * @param options - Options with {LoggerInterface} logger
 * @returns {string} - Index file path
 */
export declare function getIndexFile(path: string, options?: GetIndexFileOptions): string;
/**
 * Search for index file in the path from a list of paths
 * @param {string} path - Path to search
 * @param {string[]} paths - Available paths
 * @returns {string} - Index file path
 */
export declare function getIndexFileFromPaths(path: string, paths: string[]): string;
/**
 * Build index file regexp
 * @param sep - Separator
 * @param dirnamePath - Directory name
 * @returns {RegExp} - RegExp to match with any index file
 */
export declare function buildIndexFileRegExp(sep: string, dirnamePath: string): RegExp;