diff options
| author |  Sarah Rainsberger <sarah@rainsberger.ca>
| 2022-07-25 01:18:15 -0300 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2022-07-25 00:18:15 -0400 |
| commit | 552d23bc9bdf871498babdb775967fd803923efb (patch) | |
| tree | 1b652062b39175e89db81559fa76756a65a1dca4 | |
| parent | 6fd161d7691cbf9d3ffa4646e46059dfd0940010 (diff) | |
| download | astro-552d23bc9bdf871498babdb775967fd803923efb.tar.gz astro-552d23bc9bdf871498babdb775967fd803923efb.tar.zst astro-552d23bc9bdf871498babdb775967fd803923efb.zip | |
[Doc-generated content] legacy.astroFlavoredMarkdown (#4027)
* Update astro.ts
* custom aside syntax
* adding `@since` tag
Co-authored-by: Chris Swithinbank <swithinbank@gmail.com>
* closing comment
Co-authored-by: Chris Swithinbank <swithinbank@gmail.com>
* Update astro.ts
Co-authored-by: Chris Swithinbank <swithinbank@gmail.com>
Co-authored-by: Fred K. Schott <fkschott@gmail.com>
| -rw-r--r-- | packages/astro/src/@types/astro.ts | 33 |
1 files changed, 23 insertions, 10 deletions
diff --git a/packages/astro/src/@types/astro.ts b/packages/astro/src/@types/astro.ts index dc437fe36..32166e5f0 100644 --- a/packages/astro/src/@types/astro.ts +++ b/packages/astro/src/@types/astro.ts @@ -703,6 +703,29 @@ export interface AstroUserConfig { * ``` */ vite?: ViteUserConfig; + + /** + * @docs + * @kind heading + * @name Legacy Flags + * @description + * To help some users migrate between versions of Astro, we occasionally introduce `legacy` flags. + * These flags let you to opt-in to some deprecated or otherwise outdated behavior of Astro + * in the latest version, so that you can continue to upgrade and take advantage of new Astro releases. + */ + legacy?: { + /** + * @docs + * @name legacy.astroFlavoredMarkdown + * @type {boolean} + * @default `false` + * @since 1.0.0-rc + * @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/). + */ + astroFlavoredMarkdown?: boolean; + }; // Legacy options to be removed @@ -726,16 +749,6 @@ export interface AstroUserConfig { buildOptions?: never; /** @deprecated `devOptions` has been renamed to `server` */ devOptions?: never; - - legacy?: { - /** - * Enable components and JSX expressions in markdown - * Consider our MDX integration before applying this flag! - * @see https://docs.astro.build/en/guides/integrations-guide/mdx/ - * Default: false - */ - astroFlavoredMarkdown?: boolean; - }; } // NOTE(fks): We choose to keep our hand-generated AstroUserConfig interface so that |