Skip to content

Conversation

@jamiesun
Copy link
Contributor

🐛 问题描述

MkDocs 配置文件中的 emoji 扩展配置使用了错误的 YAML 格式,导致构建时可能出现解析错误。

🔧 修复内容

  • emoji_indexemoji_generator 从字符串格式改为使用 !!python/name 语法
  • 修复了缩进问题,确保 YAML 语法正确
  • 这是 MkDocs Material 主题推荐的配置方式

📝 变更详情

# 之前(错误)
emoji_index: "material.extensions.emoji.twemoji"
emoji_generator: "material.extensions.emoji.to_svg"

# 之后(正确)
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg

✅ 测试

  • YAML 语法检查通过
  • Pre-commit hooks 全部通过
  • MkDocs 构建测试成功

📚 参考

- 使用 git statuspython/name 语法正确引用 Python 对象
- 修复 emoji_index 和 emoji_generator 的缩进
- 确保 MkDocs 构建不会因 YAML 解析错误而失败
@jamiesun jamiesun merged commit dfba50b into main Oct 28, 2025
7 checks passed
@jamiesun jamiesun mentioned this pull request Oct 28, 2025
@jamiesun jamiesun deleted the fix/mkdocs-emoji-config branch October 28, 2025 11:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants