summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--packages/astro/src/@types/astro.ts70
1 files changed, 35 insertions, 35 deletions
diff --git a/packages/astro/src/@types/astro.ts b/packages/astro/src/@types/astro.ts
index 0c1ce5bbb..c393e7c4d 100644
--- a/packages/astro/src/@types/astro.ts
+++ b/packages/astro/src/@types/astro.ts
@@ -157,41 +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
- * 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" }],
- * ],
- * },
- * ],
- * },
- * });
- * ```
- */
+ /**
+ * @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;
};