MkDocs
使用指南

文档组件

每个 MDX 页面都能使用的可复用组件。

这些组件在 press.config.tsx 中注册,无需导入即可使用。

卡片

提示框

补充信息

在不打断主线的情况下,为读者提供有用背景。

保持实用

只在读者容易忽略重要信息时使用提示框。

可以发布

提示框支持成功、错误、警告、想法和自定义图标。

步骤引导

创建页面

content/ 下添加 .mdx 文件。

配置导航

将页面 slug 加入最近的 meta.json

标签页

pnpm install
pnpm dev

折叠面板

文件树

index.mdx
components.mdx
meta.json

API 属性

属性

类型

视频

YoutubeVideo 已经全局注册,无需在 MDX 中导入:

<YoutubeVideo url="https://www.youtube.com/embed/VIDEO_ID" />

最后更新于

本页目录