31 lines
1.0 KiB
TypeScript
31 lines
1.0 KiB
TypeScript
import { Document } from 'yaml';
|
|
/**
|
|
* Parse mkdocs.yml content with support for !!python/name: tags.
|
|
* Returns a yaml Document that preserves comments and formatting.
|
|
*/
|
|
declare function parseConfig(content: string): Document;
|
|
/**
|
|
* Validate that a string is valid YAML (with python tags support).
|
|
* Returns null if valid, error message if invalid.
|
|
*/
|
|
declare function validateYaml(content: string): string | null;
|
|
declare function readConfig(): Promise<string>;
|
|
declare function writeConfig(content: string): Promise<void>;
|
|
/**
|
|
* Trigger `mkdocs build --clean` via the build trigger HTTP server
|
|
* running inside the MkDocs container on port 8001.
|
|
*/
|
|
declare function triggerBuild(): Promise<{
|
|
success: boolean;
|
|
output: string;
|
|
duration: number;
|
|
}>;
|
|
export declare const mkdocsConfigService: {
|
|
readConfig: typeof readConfig;
|
|
writeConfig: typeof writeConfig;
|
|
validateYaml: typeof validateYaml;
|
|
parseConfig: typeof parseConfig;
|
|
triggerBuild: typeof triggerBuild;
|
|
};
|
|
export {};
|
|
//# sourceMappingURL=mkdocs-config.service.d.ts.map
|