896 字
4 分钟
页面浏览--访问次数--
Markdown 卡片与字段组

这一篇把三类「卡片」放在一起:仓库卡片、字段参数卡片、折叠面板卡片。

GitHub 仓库卡片#

效果(页面加载后会从 GitHub API 拉取仓库描述、Star 数、主语言等信息)

LyraVoidShirone

源码

::github{repo="LyraVoid/Shirone"}

写法是 ::github{repo="owner/repo"},repo 是唯一参数,取值必须是 owner/repo 形式。服务端始终会输出一个可点击的仓库链接,即使 API 请求失败也不会留下空白。

字段参数卡片组#

效果

title必填string

网站正式标题,显示在顶栏和浏览器标签页。

subtitle可选string

网站副标题,用于元数据与首页辅助展示。

源码(外层 field-group 用 4 个冒号,内层 field 用 3 个冒号)

::::field-group
:::field{name="title"}
@type string
@required
网站正式标题,显示在顶栏和浏览器标签页。
:::
:::field{name="subtitle"}
@type string
@optional
网站副标题,用于元数据与首页辅助展示。
:::
::::

字段元数据标签:

标签作用
@type <类型>以代码样式显示类型,可写 string、boolean、'a' | 'b' 等
@default <值>显示默认值
@required必填徽章
@optional可选徽章
@deprecated已废弃徽章

元数据之后的任意 Markdown 会成为字段描述;未知的 @标签 不会被丢弃,而是当作普通描述文字显示。

独立字段与丰富描述#

效果

format可选'short' | 'long'
'short'

控制结果如何格式化。描述里可以用强调、行内代码、链接和列表:

  • 保持渲染结果稳定
  • 不要在描述里发起网络请求

源码

:::field{name="format"}
@type `'short' | 'long'`
@default `'short'`
@optional
控制结果如何格式化。描述里可以用**强调**、`行内代码`、[链接](https://docs.shirone.mysqil.com/)和列表:
- 保持渲染结果稳定
- 不要在描述里发起网络请求
:::

折叠面板卡片组#

效果(accordion 表示手风琴模式:同组内只展开一个)

默认展开的项目

这里是第一个卡片的内容正文。

默认折叠的项目

这里是第二个卡片的内容正文。

源码

::: collapse accordion
- :+ 默认展开的项目
这里是第一个卡片的内容正文。
- 默认折叠的项目
这里是第二个卡片的内容正文。
:::
参数 / 标记说明
::: collapse [accordion] [expand]可选参数,accordion = 手风琴单开,expand = 默认展开
:::collapse{accordion=true expand=true}等价的属性写法(注意冒号后不能有空格外的其它细节见下)
- :+ 标题 / - :- 标题单条面板的初始状态:展开 / 折叠
条目正文缩进 2 个空格面板内容

第 12 篇,共 23 篇本文属于系列

Markdown 卡片与字段组
https://www.klucen.cn/posts/syntax/markdown-cards/
作者
KLucen
发布于
2025-12-14
许可协议
CC BY-NC-SA 4.0

分享文章

生成精美分享图或复制链接,与更多人分享本文。

继续阅读

沿着主题读

基于共同的标签与分类

换条路线

从其他文章中稳定抽取

评论

正在加载评论...

最后更新于 ,距今已过 301 天

部分内容可能已过时