Skip to content

fix(docs): 修复 6 条构建告警,使 mkdocs build --strict 通过 - #174

Closed
SZ-lizhouyi wants to merge 1 commit into
OpenHUTB:masterfrom
SZ-lizhouyi:fix/strict-build-warnings
Closed

SZ-lizhouyi wants to merge 1 commit into
OpenHUTB:masterfrom
SZ-lizhouyi:fix/strict-build-warnings

Conversation

@SZ-lizhouyi

@SZ-lizhouyi SZ-lizhouyi commented Oct 13, 2026 •

Copy link
Copy Markdown
Contributor

mkdocs build --strict 有 2 条误报,退出码 1:

  • docs/index.md 第 66 行:YouTube 链接 https://www.youtube.com/@OpenHUTB 里的 @OpenHUTB 被当成引用键
  • docs/bib_reference_guide.md 第 60 行:代码块里的 @article{example1, 被当成引用键

bibtex 插件的行内引用解析不跳过代码块,@ 后面跟字母就当引用键。仓库里没有页面使用 [@key] 这种写法,所以在 mkdocs.yml 里把它关掉。

改动 1 个文件 +1 行。本地 mkdocs build --strict:退出码 1 → 0,告警 2 → 0。改前改后各构建一次,26 个页面逐个对比,除构建时间戳外输出完全一致。

@wxhwmr

wxhwmr commented Oct 13, 2026

Copy link
Copy Markdown
Contributor

是一个合理的修复方案

@donghaiwang donghaiwang left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR信息不能直接用大模型输出,输出太多废话,干扰人的阅读

Comment thread docs/index.md

## 1. 简介 <span id="list"></span>

- [OpenHUTB 模拟器简介](./simulator.md)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这是该仓库已有的内容,一般不能删除,即使删除也需要给出理由

Comment thread docs/index.md Outdated

- [Markdown 一键发到各个社交平台](./markdown2anything.md)

- [宣传](./propagate.md)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这是该仓库已有的内容,一般不能删除,即使删除也需要给出理由

docs/index.md 的 YouTube 链接和 docs/bib_reference_guide.md 代码块里的
@Article{...} 被当成引用键,构建时报 Citing unknown reference key。

仓库里没有页面使用 [@key] 形式的行内引用,所以在插件配置里关掉。
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.

3 participants