用途 intlayer-markdown 面向使用 Intlayer 管理多语言内容的项目,重点解决 Markdown 与富文本内容的声明、本地化与渲染问题,适用于需要按语言组织 Markdown 文章或富文本片段的场景。
主要能力
- 内容声明:可在字典中使用 md("## 标题 ...") 显式声明 Markdown,也可用 t({ en: md(file(...)), fr: md(file(...)) }) 为不同语言指定外部文件。
- .content.md 文件:自 v8.10 起,可在 Markdown 文件 front-matter 中写 key(以及可选的 locale),例如 article.en.content.md、article.fr.content.md。
- 自动检测:设置 contentAutoTransformation: true(可按字典或全局写进 intlayer.config.ts),含 Markdown 语法的普通字符串会被转换。
- MDX 支持:Markdown 中使用的组件名会从 components 映射中解析。
使用方式 通过 useIntlayer 取得的 md 节点会直接渲染为框架原生输出(JSX、VNode 或 HTML 字符串)。节点提供 .use() 做局部组件覆盖、.value 读取原始 Markdown 字符串、.metadata.title 读取解析后的 front-matter;渲染优先级为 .use() > 全局 provider > 默认渲染器。全局配置因框架而异:React、Next.js、Preact、Solid、Svelte 使用 <package>/markdown 的 MarkdownProvider;Vue 使用 vue-intlayer/markdown 的 app.use(intlayerMarkdown, options);Angular 在 ApplicationConfig 中使用 createIntlayerMarkdownProvider(options);Astro 在中间件中 installIntlayerMarkdown(options) 并配 <script>;Lit 与 Vanilla 在 installIntlayer() 旁调用 installIntlayerMarkdown()。对于不来自字典的原始 Markdown 字符串,可用 <package>/markdown 提供的 <MarkdownRenderer />、useMarkdownRenderer() 和 renderMarkdown(),它们只接受原始字符串,不接受 useIntlayer 节点。
性能与选项 React 中解析器(约 55kb)通过 Suspense 懒加载,建议将渲染 Markdown 的组件包在 <Suspense> 边界内,否则 React 会在根节点挂起。SSR 场景可在服务端调用 parseMarkdown(),把可序列化的 AST 传给客户端,各渲染辅助工具都接受该 AST,从而让浏览器跳过解析。全局配置与辅助工具支持 forceBlock、forceInline、tagfilter(默认 true,会移除危险 HTML)、preserveFrontmatter、components、wrapper、renderMarkdown 等选项。
适用场景与限制 适合使用 Intlayer 做多语言、以 Markdown/MDX 维护富文本的项目。资料未说明具体版本要求(.content.md 除 v8.10 起外)、收费方式与平台限制,这些暂未提供;使用前需确认所用框架对应的集成方式。