[ci] format

This commit is contained in:
RafidMuhymin 2022-03-23 15:48:26 +00:00 committed by GitHub Actions
parent 52e75475ae
commit 29f420bb0e

View file

@ -157,41 +157,41 @@ export interface AstroUserConfig {
/** @deprecated - Use "integrations" instead. Run Astro to learn more about migrating. */ /** @deprecated - Use "integrations" instead. Run Astro to learn more about migrating. */
renderers?: string[]; renderers?: string[];
/** /**
* @docs * @docs
* @name markdownOptions * @name markdownOptions
* @type {{render: MarkdownRenderOptions}} * @type {{render: MarkdownRenderOptions}}
* @see [Markdown guide](/en/guides/markdown-content/) * @see [Markdown guide](/en/guides/markdown-content/)
* @description * @description
* Configure how markdown files (`.md`) are rendered. * Configure how markdown files (`.md`) are rendered.
* *
* ```js * ```js
* import { defineConfig } from "astro/config"; * import { defineConfig } from "astro/config";
* import astroRemark from "@astrojs/markdown-remark"; * import astroRemark from "@astrojs/markdown-remark";
* import customRehypePlugin from "/path/to/rehypePlugin.mjs"; * import customRehypePlugin from "/path/to/rehypePlugin.mjs";
* *
* export default defineConfig({ * export default defineConfig({
* // Enable Custom Markdown options, plugins, etc. * // Enable Custom Markdown options, plugins, etc.
* markdownOptions: { * markdownOptions: {
* render: [ * render: [
* // The Remark parser to parse Markdown content * // The Remark parser to parse Markdown content
* astroRemark, * astroRemark,
* { * {
* // Add a Remark plugin to your project. * // Add a Remark plugin to your project.
* remarkPlugins: ["remark-code-titles"], * remarkPlugins: ["remark-code-titles"],
* *
* // Add a Rehype plugin to your project. * // Add a Rehype plugin to your project.
* rehypePlugins: [ * rehypePlugins: [
* "rehype-slug", * "rehype-slug",
* [customRehypePlugin, { configKey: "value" }], * [customRehypePlugin, { configKey: "value" }],
* ["rehype-autolink-headings", { behavior: "prepend" }], * ["rehype-autolink-headings", { behavior: "prepend" }],
* ], * ],
* }, * },
* ], * ],
* }, * },
* }); * });
* ``` * ```
*/ */
markdownOptions?: { markdownOptions?: {
render?: MarkdownRenderOptions; render?: MarkdownRenderOptions;
}; };