Markdown / 富文本内容

Markdown 的工作原理

Intlayer 支持使用 Markdown 语法定义的富文本内容。这是通过 md 函数实现的，该函数将 Markdown 字符串转换为可以由 Intlayer 管理的格式。通过使用 Markdown，您可以轻松地书写和维护具有丰富格式的内容，例如博客、文章等。

Intlayer 可视化编辑器 和 Intlayer CMS 都支持 Markdown 内容管理。

在与 React 应用程序集成时，您可以使用一个 Markdown 渲染提供程序（例如 markdown-to-jsx）将 Markdown 内容渲染为 HTML。这使您能够用 Markdown 编写内容，同时确保它在您的应用程序中正确显示。

设置 Markdown 内容

要在 Intlayer 项目中设置 Markdown 内容，请定义一个使用 md 函数的内容词典。

TypeScript 示例

import { md, type Dictionary } from "intlayer";const markdownDictionary = {  key: "app",  content: {    myMarkdownContent: md("## 我的标题 \n\nLorem Ipsum"),  },} satisfies Dictionary;export default markdownDictionary;

JavaScript (ESM) 示例

CommonJS 示例

JSON 示例

使用 JSON 时，可以通过设置 nodeType（例如 "markdown"）并提供 Markdown 字符串来定义 Markdown 内容。例如：

在 React Intlayer 中使用 Markdown

要在 React 应用程序中渲染 Markdown 内容，您可以结合使用 react-intlayer 包中的 useIntlayer 钩子和一个 Markdown 渲染提供程序。在本示例中，我们使用 markdown-to-jsx 包将 Markdown 转换为 HTML。

import { FC } from "react";import { useIntlayer, MarkdownProvider } from "react-intlayer";import { LocaleRouter } from "./Router";import Markdown from "markdown-to-jsx";import "./App.css";const AppContent: FC = () => {  const { myMarkdownContent } = useIntlayer("app");  return <>{myMarkdownContent}</>;};const App: FC = () => (  <LocaleRouter>    <MarkdownProvider      renderMarkdown={(markdown) => <Markdown>{markdown}</Markdown>}    >      <AppContent />    </MarkdownProvider>  </LocaleRouter>);export default App;

在此实现中：

• MarkdownProvider 包裹了应用程序（或其相关部分），并接受一个 renderMarkdown 函数。此函数用于通过 markdown-to-jsx 包将 Markdown 字符串转换为 JSX。
• useIntlayer 钩子用于从键 "app" 的词典中检索 Markdown 内容（myMarkdownContent）。
• Markdown 内容直接在组件中渲染，并由提供程序处理 Markdown 的渲染。

额外资源

• Intlayer CLI 文档
• React Intlayer 文档
• Next Intlayer 文档
• npm 上的 markdown-to-jsx

这些资源为设置和使用 Intlayer 以及各种内容类型和框架提供了进一步的见解。