Link Cards 组件
LinkCard 用于把文档入口做成统一视觉卡片,适合首页导航、章节跳转和资源推荐。
GithubInfo 与 BilibiliCard 是特殊形态的链接卡片:保留卡片式入口,但针对 GitHub 仓库与 B 站视频做了固定信息结构。
基础用法(默认样式)
Markdown
<LinkCard
title="Markdown 创作"
href="/guides/"
description="面向内容编写的文档入口示例。"
icon="mdi:card-text-outline"
badge="推荐"
/>图标/图片与位置(默认/长条通用)
三种排版
1. 默认样式(单列)
2. 长条形(每行 2 个)
3. 正方形(每行 4 个)
GithubInfo(特殊 LinkCard)
面向 GitHub 仓库的紧凑卡片:展示 owner/repo,并请求公开 API 显示 stars / forks。
vuejscore
Markdown
<GithubInfo owner="vuejs" repo="core" />| 参数 | 类型 | 默认值 | 说明 | 示例 |
|---|---|---|---|---|
owner | string | '' | 仓库所有者,必填。 | owner="vuejs" |
repo | string | '' | 仓库名,必填。 | repo="core" |
token | string | '' | 可选 GitHub token,提高 API 限额。 | token="ghp_..." |
baseUrl | string | https://api.github.com | API 根地址。 | base-url="https://api.github.com" |
注意:
- 浏览器端直接请求 GitHub 公开 API;无 token 时可能受速率限制。
- 失败时仍保留仓库链接,计数显示为
—,并给出简短错误提示。
BilibiliCard(特殊 LinkCard)
面向 B 站视频的入口卡片,固定使用 B 站品牌色与图标。
示例视频入口
适合把教程视频做成可点击卡片。
Markdown
<BilibiliCard
title="示例视频入口"
href="https://www.bilibili.com/video/BV1hDDRBeEib/"
description="适合把教程视频做成可点击卡片。"
author="官方账号"
/>
<!-- 或只给 bvid -->
<BilibiliCard
title="示例视频入口"
bvid="BV1hDDRBeEib"
description="自动拼出 B 站视频链接。"
/>| 参数 | 类型 | 默认值 | 说明 | 示例 |
|---|---|---|---|---|
title | string | '' | 卡片标题,必填。 | title="安装演示" |
href | string | '' | 完整视频链接;与 bvid 二选一。 | href="https://www.bilibili.com/video/BVxxx/" |
bvid | string | '' | B 站 BV 号;未给 href 时自动拼链接。 | bvid="BV1hDDRBeEib" |
description | string | '' | 描述文本。 | description="入门演示" |
author | string | '' | UP 主/来源。 | author="官方账号" |
cover | string | '' | 可选封面图。 | cover="/demo-cover.jpg" |
disabled | boolean | false | 禁用交互。 | :disabled="true" |
LinkCard Props
| 参数 | 类型 | 默认值 | 说明 | 示例 |
|---|---|---|---|---|
title | string | '' | 卡片标题,建议必填。 | title="Markdown 创作" |
href | string | '' | 跳转地址,建议必填。 | href="/guides/" |
description | string | '' | 描述文本。 | description="课程入口" |
icon | string | mdi:link-variant | Iconify 图标。 | icon="mdi:card-text-outline" |
image | string | '' | 图片图标地址。 | image="/favicon.ico" |
imageAlt | string | '' | 图片替代文本。 | image-alt="课程图标" |
mediaPosition | left | right | background | left | 图标/图片位置。 | media-position="background" |
layout | default | strip | square | default | 卡片排版模式。 | layout="strip" |
badge | string | '' | 标题旁角标文本。 | badge="推荐" |
target | string | '' | 强制指定打开方式。 | target="_blank" |
disabled | boolean | false | 禁用交互状态。 | :disabled="true" |
注意事项
- 组件名区分大小写,统一使用 PascalCase。
- 站内链接使用 Clean URL,不要写
.html后缀。 - 当
title或href缺失时,LinkCard会显示<code><LinkCard /></code>占位。 - 在
layout="square"下:left表示 logo 在上方,right表示 logo 在下方,background表示 logo 在底部。