0
Fork 0
mirror of https://github.com/withastro/astro.git synced 2025-01-13 22:11:20 -05:00

[ci] format

This commit is contained in:
Sarah Rainsberger 2024-11-11 13:50:33 +00:00 committed by astrobot-houston
parent 95d52a0236
commit 471e7127a3

View file

@ -1439,47 +1439,47 @@ export interface AstroUserConfig {
* @typeraw {Partial<ShikiConfig>} * @typeraw {Partial<ShikiConfig>}
* @description * @description
* Shiki is our default syntax highlighter. You can configure all options via the `markdown.shikiConfig` object: * Shiki is our default syntax highlighter. You can configure all options via the `markdown.shikiConfig` object:
* *
* ```js title="astro.config.mjs" * ```js title="astro.config.mjs"
* import { defineConfig } from 'astro/config'; * import { defineConfig } from 'astro/config';
* *
* export default defineConfig({ * export default defineConfig({
* markdown: { * markdown: {
* shikiConfig: { * shikiConfig: {
* // Choose from Shiki's built-in themes (or add your own) * // Choose from Shiki's built-in themes (or add your own)
* // https://shiki.style/themes * // https://shiki.style/themes
* theme: 'dracula', * theme: 'dracula',
* // Alternatively, provide multiple themes * // Alternatively, provide multiple themes
* // See note below for using dual light/dark themes * // See note below for using dual light/dark themes
* themes: { * themes: {
* light: 'github-light', * light: 'github-light',
* dark: 'github-dark', * dark: 'github-dark',
* }, * },
* // Disable the default colors * // Disable the default colors
* // https://shiki.style/guide/dual-themes#without-default-color * // https://shiki.style/guide/dual-themes#without-default-color
* // (Added in v4.12.0) * // (Added in v4.12.0)
* defaultColor: false, * defaultColor: false,
* // Add custom languages * // Add custom languages
* // Note: Shiki has countless langs built-in, including .astro! * // Note: Shiki has countless langs built-in, including .astro!
* // https://shiki.style/languages * // https://shiki.style/languages
* langs: [], * langs: [],
* // Add custom aliases for languages * // Add custom aliases for languages
* // Map an alias to a Shiki language ID: https://shiki.style/languages#bundled-languages * // Map an alias to a Shiki language ID: https://shiki.style/languages#bundled-languages
* // https://shiki.style/guide/load-lang#custom-language-aliases * // https://shiki.style/guide/load-lang#custom-language-aliases
* langAlias: { * langAlias: {
* cjs: "javascript" * cjs: "javascript"
* }, * },
* // Enable word wrap to prevent horizontal scrolling * // Enable word wrap to prevent horizontal scrolling
* wrap: true, * wrap: true,
* // Add custom transformers: https://shiki.style/guide/transformers * // Add custom transformers: https://shiki.style/guide/transformers
* // Find common transformers: https://shiki.style/packages/transformers * // Find common transformers: https://shiki.style/packages/transformers
* transformers: [], * transformers: [],
* }, * },
* }, * },
* }); * });
* ``` * ```
* *
* See the [code syntax highlighting guide](/en/guides/syntax-highlighting/) for usage and examples. * See the [code syntax highlighting guide](/en/guides/syntax-highlighting/) for usage and examples.
*/ */
shikiConfig?: Partial<ShikiConfig>; shikiConfig?: Partial<ShikiConfig>;