卡片与字段组

Shirone 提供了丰富的卡片系统，包括 GitHub 仓库卡片、API 字段参数卡片组以及折叠卡片组。

GitHub 仓库卡片#

使用 ::github 指令自动拉取并展示 GitHub 仓库信息（含名称、简介、Star 数与主语言）：

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

3
::github{repo="LyraVoid/Shirone-Docs"}

渲染效果：

LyraVoidShirone

LyraVoidShirone-Docs

仓库信息在构建期获取并缓存，页面本身不会在浏览器里请求 GitHub API。

API 字段参数卡片组#

在编写技术文档、API 说明或配置项手册时，使用 field-group 与 field 容器生成结构化的参数卡片：

1
::::field-group
2

3
:::field{name="title"}
4
@type string
5
@required
6

7
网站正式标题，显示在顶栏和浏览器标签页。
8
:::
9

10
:::field{name="subtitle"}
11
@type string
12
@optional
13

14
网站副标题，用于元数据与首页辅助展示。
15
:::
16

17
:::field{name="themeColor"}
18
@type number
19
@optional
20
@default 315
21

22
主题色相值，决定全站的动态配色基准。
23
:::
24

25
::::

渲染效果：

title必填string

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

subtitle可选string

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

themeColor可选number

315

主题色相值，决定全站的动态配色基准。

字段名写在 ::: field 之后，首段以 @ 开头的行用于声明类型与约束：

标记	含义
`@type <类型>`	参数数据类型
`@required`	必填项
`@optional`	可选项
`@default <值>`	默认值

折叠面板卡片#

1
::: collapse accordion
2
- :+ 默认展开的项目
3

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

6
- 默认折叠的项目
7

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

渲染效果：

默认展开的项目

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

默认折叠的项目

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

:+ 前缀标记该项默认展开，未标注的项默认折叠。

1
::: collapse
2
- 独立的折叠标题
3

4
  折叠正文内容。
5
:::

渲染效果：

独立的折叠标题

折叠正文内容。

选型对照#

信息形态	推荐组件
一个开源仓库的概览	`::github` 卡片
一组配置项的逐条说明	`field-group`
需要读者主动展开的长内容	`collapse`

二甲基

GitHub 仓库卡片#

API 字段参数卡片组#

折叠面板卡片#

选型对照#

Markdown 语法

继续阅读

换条路线

评论

二甲基

GitHub 仓库卡片#

API 字段参数卡片组#

折叠面板卡片#

选型对照#

分享文章

沿着主题读

换条路线

评论