跳转至

标签插件使用

使用标签系统组织和分类你的文档内容

功能状态

标签基础功能已可用(可在文章中添加标签),但标签列表页(Tag indexes)目前不支持。 官方正在开发中,预计将在未来版本提供。

什么是标签系统?

标签系统允许你为文章添加关键词标签:

  • 内容分类 - 按主题组织文章
  • 搜索过滤 - 在搜索中按标签过滤
  • ⚠️ 标签列表页 - 自动生成标签页面(开发中)

基本配置

标签功能无需配置即可使用。如需自定义标签图标,可以添加:

[project.extra.tags]
# 为特定标签配置图标
icons = [
    { name = "Python", icon = "fontawesome/brands/python" },
    { name = "JavaScript", icon = "fontawesome/brands/js" },
]

使用方法

为文章添加标签

在文章的 front matter 中添加 tags 字段:

---
title: Python 装饰器详解
date: 2025-01-22
tags:
  - Python
  - 装饰器
  - 高级特性
  - 函数式编程
---

# Python 装饰器详解

文章内容...

标签列表页(开发中)

功能尚未实现

自动生成的标签列表页(Tag indexes)目前不支持。 官方明确标记为 "currently not supported"。

临时解决方案:手动创建标签索引页面

创建 docs/tags.md 文件,手动列出所有标签:

---
title: 标签
hide:
  - toc
---

# 标签

## Python

- [Python 装饰器详解](../articles/decorators.md)
- [Python 异步编程](../articles/async.md)

## JavaScript

- [JavaScript 基础](../articles/js-basics.md)

在导航中添加标签页

nav = [
    { "主页" = "index.md" },
    { "标签" = "tags.md" },
    # ... 其他导航项
]

标签命名规范

推荐做法

  • ✅ 使用简洁明了的标签名
  • ✅ 保持标签命名一致性
  • ✅ 使用常见术语
  • ✅ 控制标签数量(每篇 3-5 个)

避免做法

  • ❌ 使用过长的标签名
  • ❌ 同一概念使用多个标签(如 "JS" 和 "JavaScript")
  • ❌ 使用过于宽泛的标签
  • ❌ 每篇文章添加过多标签

标签示例

技术博客标签

tags:
  - Python
  - JavaScript
  - Web 开发
  - 数据库
  - API
  - 教程
  - 最佳实践

文档项目标签

tags:
  - 快速开始
  - 配置
  - 部署
  - 故障排除
  - API 参考
  - 示例

标签与分类的区别

特性 标签 (Tags) 分类 (Categories)
数量 可以有多个 通常 1-2 个
层级 扁平结构 可以有层级
用途 细粒度分类 主题分类
示例 Python, 装饰器, 教程 技术, 生活

同时使用标签和分类

---
title: Python 装饰器详解
date: 2025-01-22
categories:
  - 技术
  - Python
tags:
  - 装饰器
  - 函数式编程
  - 高级特性
---

自定义标签样式

docs/stylesheets/extra.css 中自定义标签样式:

/* 标签基础样式 */
.md-tag {
    background-color: var(--md-primary-fg-color);
    color: white;
    padding: 0.2rem 0.5rem;
    border-radius: 0.25rem;
    font-size: 0.75rem;
    margin-right: 0.25rem;
}

/* 标签悬停效果 */
.md-tag:hover {
    opacity: 0.8;
}

/* 特定标签颜色 */
.md-tag[data-tag="Python"] {
    background-color: #3776ab;
}

.md-tag[data-tag="JavaScript"] {
    background-color: #f7df1e;
    color: black;
}

常见问题

标签页面不显示

问题:创建了 tags.md 但标签列表没有自动生成

原因:标签列表页(Tag indexes)功能目前不支持

解决方案

  1. 手动维护标签列表页
  2. 等待官方实现该功能
  3. 使用搜索功能按标签过滤文章

标签链接 404

问题:点击标签链接出现 404

解决方案

  1. 检查 site_url 配置
  2. 确保标签页面存在
  3. 清理并重新构建:zensical build --clean

参考资源


提示:合理使用标签可以大大提升内容的可发现性!