跳转到主要内容

组件呈现

在 OINK 四种视觉预设中查看卡片、折叠块、标签页和紧凑流程。

使用外观菜单切换 Paper、Slate、Ink、Terminal 及明暗模式,比较同一批内容的呈现。以下示例继续沿用通常的 Markdown 写作方式。

OINK 1.4.0 已提供

本页的可选变体已随 OINK 1.4.0 发布。

相关页面

紧凑的资源目录可以使用 {.cards .td-cards-list}。分隔列表共用一个外框,说明文字可以自然换行。

需要图标、徽章或块级说明时,完整形式支持 cards variant="list":

安装从这里开始

先建立本地预览,再调整站点配置。

提示与折叠块

保持本地预览

除了桌面效果,也要检查窄屏上的页面。

检查目标位置

发布新版本之前,确认目标位置正确。

不启用 JavaScript 时如何工作?

折叠块使用原生 HTML details 元素,禁用脚本后仍然可以操作。

标题、箭头与焦点轮廓位于同一个尺寸稳定的摘要行中。

较长的标题可以自然换行,不会挤走箭头或缩小整行的操作区域

每个折叠块独立展开,其他内容保持原有状态。

标签页与命令

macOS / Homebrew
brew install hugo
Debian / Ubuntu
sudo apt install hugo

单行围栏代码块加上 {class="td-code-command"} 后显示为命令条。复制按钮独占一列,命令可以滚动或换行,不会被按钮遮挡。

hugo server --bind 127.0.0.1 --port 1313
hugo --environment production --baseURL https://example.com/documentation/ --destination public

wrap、copy 和无障碍标签保持原有含义。多行、带行号或可折叠的输入会给出警告并回退到普通代码块。没有该修饰类的单行代码块保留通常的呈现。

短流程

在简短有序列表后添加 {.steps .td-steps-compact}。较长教程仍可使用常规 .steps 布局。

  1. 检查配置。
  2. 运行本地预览。
  3. 检查生成结果。

需要标题的流程使用百分号分隔的 steps variant="compact":

预览

运行开发服务器,打开修改的页面。

检查

按读者使用的语言和外观检查页面。

表格与元信息

视图 用途 输入
卡片 相关资源 链接列表
步骤 有序流程 有序列表
标签页 等价选项 相邻内容块
title , 类型string
简洁的标题,允许自然换行。
description , 类型string
与主要标签分开的辅助信息。

预览 已验证 待检查

用 Ctrl 加 K 打开搜索,用方向键切换结果。

兼容性

这些变体不加载额外运行时。已有链接、键盘操作、复制文字、打印内容与 Markdown 输出保持原有含义。不支持的 cards 或 steps 变体会给出警告并使用常规呈现。视觉精修不改变默认预设或字体政策。