docs: Modify legacy flag description (#4187)

Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
This commit is contained in:
Mark Spratt 2022-08-07 04:18:33 -05:00 committed by GitHub
parent 3a7e0221b3
commit 341344f331
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -724,6 +724,17 @@ export interface AstroUserConfig {
* @description
* Enable Astro's pre-v1.0 support for components and JSX expressions in `.md` Markdown files.
* In Astro `1.0.0-rc`, this original behavior was removed as the default, in favor of our new [MDX integration](/en/guides/integrations-guide/mdx/).
*
* To enable this behavior, set `legacy.astroFlavoredMarkdown` to `true` in your [`astro.config.mjs` configuration file](/en/guides/configuring-astro/#the-astro-config-file).
*
* ```js
* {
* legacy: {
* // Example: Add support for legacy Markdown features
* astroFlavoredMarkdown: true,
* },
* }
* ```
*/
astroFlavoredMarkdown?: boolean;
};