Rpress 支持 Mdx,这是一种功能强大的内容开发方式,你可以在 Markdown 文件中导入和使用 React 组件。
MDX 是 Markdown 的超集,这意味着可以像往常一样编写 Markdown 文件。例如:
# Hello World
当你想在 Markdown 文件中使用 React 组件时,你应该使用 .mdx
扩展名来命名你的文件。例如:
// docs/index.mdx
import { CustomComponent } from './custom';
# Hello World
<CustomComponent />
你可以在 Markdown 文件的开头添加 Front Matter,它是一个 YAML 格式的对象,用于定义一些元数据。例如:
---
title: Hello World
---
注意:默认情况下,Rpress 使用 h1 标题作为 html 的标题。
你还可以在正文中访问 Front Mattter 中定义的属性,例如:
---
title: Hello World
---
# {frontmatter.title}
前面定义的属性将作为 meta
属性传递给组件。所以最终输出将是:
<h1>Hello World</h1>