@studiocms/markdoc
Version:
Add MarkDoc Support to your StudioCMS project with ease!
21 lines (20 loc) • 1.13 kB
TypeScript
/**
* These triple-slash directives defines dependencies to various declaration files that will be
* loaded when a user imports the StudioCMS plugin in their Astro configuration file. These
* directives must be first at the top of the file and can only be preceded by this comment.
*/
/// <reference types="./virtual.d.ts" preserve="true" />
import type { AstroIntegration } from 'astro';
import { type StudioCMSPlugin } from 'studiocms/plugins';
import type { MarkDocPluginOptions } from './types.js';
/**
* Creates an internal Astro integration for MarkDoc rendering.
* This is used for testing and internal purposes.
*
* @param {string} packageIdentifier - The package identifier for the integration.
* @param {MarkDocPluginOptions} [options] - Optional configuration options for the MarkDoc plugin.
* @returns {AstroIntegration} The configured Astro integration.
*/
export declare function internalMarkDocIntegration(packageIdentifier: string, options?: MarkDocPluginOptions): AstroIntegration;
export declare function studiocmsMarkDoc(options?: MarkDocPluginOptions): StudioCMSPlugin;
export default studiocmsMarkDoc;