Skip to content

优化 README 导航锚点与重复章节,提升可读性#1

Open
CoderXingZhang wants to merge 1 commit into
masterfrom
codex/identify-performance-optimizations-and-refactor-code
Open

优化 README 导航锚点与重复章节,提升可读性#1
CoderXingZhang wants to merge 1 commit into
masterfrom
codex/identify-performance-optimizations-and-refactor-code

Conversation

@CoderXingZhang

Copy link
Copy Markdown
Owner

Motivation

  • 修复 README 中目录根锚点不明确和重复的「微博、微信公众号」章节,避免导航跳转混淆并降低维护成本。
  • 提升文档可读性与可访问性,使信息更精简一致。

Description

  • 将顶部标题由 # Java资源大全中文版 改为带显式锚点的 <h1 id="awesome-java-cn">Java资源大全中文版</h1>,确保目录首项跳转稳定可用。
  • 合并并移除重复的 weibo-weixin 区块,统一保留一处条目并精简文案以减少冗余。
  • 规范公众号二维码图片为 <img ... width="150" height="150" alt="...">,补齐 alt 属性并统一尺寸以提升可访问性与视觉一致性。

Testing

  • 运行 rg 'id="weibo-weixin"|awesome-java-cn' -n README.md 验证锚点位置与出现次数,结果通过。
  • 运行用于查找 id="..." 重复的 Python 脚本以确认没有重复 id,结果通过。
  • 使用 git diff -- README.md 检查变更差异以人工/自动化审阅,变更内容符合预期。

Codex Task

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant