跳转到内容

Sätteri API 参考

添加于: [email protected]

Sätteri 是 Astro 的默认 Markdown 处理器。@astrojs/markdown-satteri 包是可选的,安装后可启用 Sätteri 专属功能和插件。它还提供了一组辅助函数和类型,可用于构建集成或插件。

有关功能和使用示例,请参阅 Markdown 指南中的 Markdown 处理器。

以下辅助函数从 @astrojs/markdown-satteri 导入:

import {
createSatteriMarkdownProcessor,
isSatteriProcessor,
satteri,
satteriHeadingIdsPlugin,
} from "@astrojs/markdown-satteri";

类型: (opts?: SatteriMarkdownProcessorOptions | undefined) => Promise<MarkdownRenderer>

创建一个独立的、基于 Sätteri 的 Markdown 渲染器。如果你需要脱离项目已配置的 markdown.processor 来渲染 Markdown,这会很有用。

src/utils/markdown.ts
import { createSatteriMarkdownProcessor } from "@astrojs/markdown-satteri";
const processor = await createSatteriMarkdownProcessor();
const { code, metadata } = await processor.render("# Hello world");

类型: (p: { name: string; }) => boolean

判断给定的处理器是否为 Sätteri。如果你需要在应用 Sätteri 专属逻辑之前检查处理器类型,这会很有用。

以下示例在集成中检查已配置的 Markdown 处理器是否为 Sätteri:

src/integrations/my-integration.ts
import { isSatteriProcessor } from "@astrojs/markdown-satteri";
import type { AstroIntegration } from "astro";
export default function myIntegration(): AstroIntegration {
return {
name: "my-integration",
hooks: {
"astro:config:done": ({ config }) => {
if (isSatteriProcessor(config.markdown.processor)) {
// Apply Sätteri-specific logic here
}
},
},
};
}

类型: (options?: SatteriProcessorOptions) => MarkdownProcessor

创建基于 Sätteri 的 Markdown 处理器,用于渲染 .md 和 .mdx 文件。将它传递给 markdown.processor,即可自定义 Markdown 的渲染行为。

请参阅 Markdown 指南,了解如何设置 Markdown 处理器以及使用 mdast 和 hast 插件。

类型: SatteriProcessorOptions

你可以使用以下选项来自定义 Sätteri 处理器的行为。

类型: MdastPluginList | undefined
默认值: []

传递 Sätteri mdast 插件,以自定义 Markdown 的构建方式。

以下示例将 satteri-emoji 插件传递给 Sätteri 处理器:

astro.config.mjs
import { satteri } from "@astrojs/markdown-satteri";
import { satteriEmoji } from "satteri-emoji";
export default {
markdown: {
processor: satteri({
mdastPlugins: [satteriEmoji],
}),
},
};

类型: HastPluginList | undefined
默认值: []

传递 Sätteri hast 插件,以自定义如何根据 Markdown 内容生成 HTML。

以下示例将 satteri-custom-header-id 插件传递给 Sätteri 处理器:

astro.config.mjs
import { satteri } from "@astrojs/markdown-satteri";
import { satteriCustomHeaderId } from "satteri-custom-header-id";
export default {
markdown: {
processor: satteri({
hastPlugins: [satteriCustomHeaderId],
}),
},
};

类型: SatteriFeatures
默认值: {}

自定义 Sätteri 提供的功能。

以下属性在 Astro 中使用了不同的默认值。

类型: boolean | object
默认值: true

是否使用智能标点,将直引号转换为弯引号、将两个连字符转换为 em dash,并将三个句点转换为省略号。

你可以禁用此功能,也可以提供配置对象,并使用 Sätteri 支持的属性来自定义行为。

以下示例会禁用智能标点:

astro.config.mjs
import { defineConfig } from "astro/config";
import { satteri } from "@astrojs/markdown-satteri";
export default defineConfig({
markdown: {
processor: satteri({
smartPunctuation: false,
}),
},
});
请参阅 Markdown 指南,了解如何配置智能标点。

类型: HastPluginEntry

为 Markdown 内容中的所有标题生成并收集标题 ID。导入或渲染 Markdown 内容时,可以使用这些 ID。

有关用法示例,请参阅 Markdown 指南中的标题 ID 与插件。

以下类型从 @astrojs/markdown-satteri 导入:

import type {
SatteriAstroData,
SatteriMarkdownProcessorOptions,
} from "@astrojs/markdown-satteri";

类型: { frontmatter: Record<string, any>; headings: MarkdownHeading[]; localImagePaths: Set<string>; remoteImagePaths: Set<string>; }

添加于: @astrojs/[email protected]

描述 Sätteri 插件中通过 ctx.data.astro 提供的 Astro 专属数据。

类型: Record<string, any>

包含插件注入到 Markdown 或 MDX 内容 frontmatter 中的属性。

请参阅 Markdown 指南,了解如何以编程方式修改 frontmatter。

类型: MarkdownHeading[]

Markdown 内容中收集到的标题列表。

类型: Set<string>

Markdown 内容自身引用的本地图片路径数组。

类型: Set<string>

Markdown 内容自身引用的远程图片路径数组。

类型: AstroMarkdownOptions & { mdastPlugins?: MdastPluginList; hastPlugins?: HastPluginList; features?: SatteriFeatures; }

描述 Markdown 处理器的配置。它包含所有 markdown 选项,以及以下选项。

SatteriMarkdownProcessorOptions.mdastPlugins

Section titled “SatteriMarkdownProcessorOptions.mdastPlugins”

类型: MdastPluginList

传递给处理器的 Sätteri mdast 插件列表。

SatteriMarkdownProcessorOptions.hastPlugins

Section titled “SatteriMarkdownProcessorOptions.hastPlugins”

类型: HastPluginList

传递给处理器的 Sätteri hast 插件列表。

类型: SatteriFeatures

包含要在 Sätteri 处理器中启用或禁用的功能配置。

贡献 社区 赞助