From b4cb4a40df33b82bcd36e63bd488bd037e94dbc0 Mon Sep 17 00:00:00 2001 From: Corbin Crutchley Date: Tue, 12 Jul 2022 06:07:51 -0700 Subject: fix: add TypeScript type and documentation for markdown "mode" config (#3883) * fix: add TypeScript type and documentation for markdown "mode" config * chore: add changeset --- packages/astro/src/@types/astro.ts | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) (limited to 'packages') diff --git a/packages/astro/src/@types/astro.ts b/packages/astro/src/@types/astro.ts index fff3f9f6c..78ba9e301 100644 --- a/packages/astro/src/@types/astro.ts +++ b/packages/astro/src/@types/astro.ts @@ -513,6 +513,27 @@ export interface AstroUserConfig { */ drafts?: boolean; + /** + * @docs + * @name markdown.mode + * @type {'md' | 'mdx'} + * @default `mdx` + * @description + * Control if markdown processing is done using MDX or not. + * + * MDX processing enables you to use JSX inside your Markdown files. However, there may be instances where you don't want this behavior, and would rather use a "vanilla" markdown processor. This field allows you to control that behavior. + * + * ```js + * { + * markdown: { + * // Example: Use non-MDX processor for Markdown files + * mode: 'md', + * } + * } + * ``` + */ + mode?: 'md' | 'mdx'; + /** * @docs * @name markdown.shikiConfig -- cgit v1.2.3