diff options
| -rw-r--r-- | packages/astro/src/@types/astro.ts | 62 |
1 files changed, 35 insertions, 27 deletions
diff --git a/packages/astro/src/@types/astro.ts b/packages/astro/src/@types/astro.ts index f634bf694..0c1ce5bbb 100644 --- a/packages/astro/src/@types/astro.ts +++ b/packages/astro/src/@types/astro.ts @@ -157,33 +157,41 @@ export interface AstroUserConfig { /** @deprecated - Use "integrations" instead. Run Astro to learn more about migrating. */ renderers?: string[]; - /** - * @docs - * @name markdownOptions - * @type {{render: MarkdownRenderOptions}} - * @see [Markdown guide](/en/guides/markdown-content/) - * @description - * Configure how markdown files (`.md`) are rendered. - * - * ```js - * { - * markdownOptions: { - * // Add a Remark plugin to your project. - * remarkPlugins: [ - * ['remark-autolink-headings', { behavior: 'prepend'}], - * ], - * // Add a Rehype plugin to your project. - * rehypePlugins: [ - * 'rehype-slug', - * ['rehype-autolink-headings', { behavior: 'prepend'}], - * ], - * // Customize syntax highlighting - * syntaxHighlight: 'shiki', - * }, - * } - * ``` - */ - /** Options for rendering markdown content */ + /** + * @docs + * @name markdownOptions + * @type {{render: MarkdownRenderOptions}} + * @see [Markdown guide](/en/guides/markdown-content/) + * @description + * Configure how markdown files (`.md`) are rendered. + * + * ```js + * import { defineConfig } from "astro/config"; + * import astroRemark from "@astrojs/markdown-remark"; + * import customRehypePlugin from "/path/to/rehypePlugin.mjs"; + * + * export default defineConfig({ + * // Enable Custom Markdown options, plugins, etc. + * markdownOptions: { + * render: [ + * // The Remark parser to parse Markdown content + * astroRemark, + * { + * // Add a Remark plugin to your project. + * remarkPlugins: ["remark-code-titles"], + * + * // Add a Rehype plugin to your project. + * rehypePlugins: [ + * "rehype-slug", + * [customRehypePlugin, { configKey: "value" }], + * ["rehype-autolink-headings", { behavior: "prepend" }], + * ], + * }, + * ], + * }, + * }); + * ``` + */ markdownOptions?: { render?: MarkdownRenderOptions; }; |