MDX 组件使用指南

345 字
2 分钟
MDX 组件使用指南
AI 概括

点击按钮,AI 将为你生成这篇文章的摘要

本指南介绍博客中可用的自定义 MDX 组件。在 .mdx 文件中通过 import 导入后即可使用。

Timeline 时间轴#

用于展示更新日志,左侧竖线 + 圆点 + 标签徽章。

参数#

参数类型必填说明
datestring日期文本,如 "2026-05-28"
typestringfeature / improvement / fix / removal,默认 feature
versionstring版本号,如 "v1.2.0"

示例#

import Timeline from "../../components/mdx/Timeline.astro";
<Timeline date="2026-05-28" type="feature" version="v1.2.0">
新增音乐页面,支持本地播放列表。
</Timeline>
<Timeline date="2026-05-27" type="fix">
修复移动端导航栏显示问题。
</Timeline>

MusicCard 音乐卡片#

展示单首歌曲信息,包含封面、歌名、歌手和播放链接。

参数#

参数类型必填说明
titlestring歌曲名称
artiststring歌手名称
coverstring封面图片 URL
urlstring播放链接

示例#

import MusicCard from "../../components/mdx/MusicCard.astro";
<MusicCard title="知我" artist="国风堂" />
<MusicCard title="女孩" artist="韦礼安" cover="/images/cover.jpg" url="https://music.163.com" />

TagBadge 标签徽章#

通用类型标签,用于标记内容类别。

参数#

参数类型必填说明
typestringfeature / improvement / fix / removal
textstring自定义文本,不填则使用默认中文标签

示例#

import TagBadge from "../../components/mdx/TagBadge.astro";
<TagBadge type="feature" />
<TagBadge type="fix" text="Bug Fix" />

使用须知#

  • 这些组件只能在 .mdx 文件中使用,普通 .md 文件不支持 import 语法
  • 导入路径根据组件所在位置确定,一般为 ../../components/mdx/组件名.astro
  • 组件样式已内置,无需额外配置

支持与分享

如果这篇文章对你有帮助,欢迎分享给更多人或赞助支持!

赞助
MDX 组件使用指南
https://f3f3.top/posts/mdx-guide/
作者
lyf
发布于
2026-05-28
许可协议
CC BY-NC-SA 4.0

评论区

Profile Image of the Author
lyf
Hello, I'm LyF.
公告
欢迎来到一飞的博客!。
音乐
封面

音乐

暂未播放

0:00 0:00
暂无歌词
分类
标签
站点统计
文章
14
分类
5
标签
16
总字数
48,064
运行时长
0
最后活动
0 天前

文章目录

🤖 AI 助手

👋 你好!

我可以帮你解答关于这篇文章的问题