Skip to content

docs: 修正 README 中失效的目录锚点与文档路径 - #122

Open
dajiaohuang wants to merge 1 commit into
jihe520:mainfrom
dajiaohuang:docs/readme-fix-broken-links
Open

docs: 修正 README 中失效的目录锚点与文档路径#122
dajiaohuang wants to merge 1 commit into
jihe520:mainfrom
dajiaohuang:docs/readme-fix-broken-links

Conversation

@dajiaohuang

Copy link
Copy Markdown

改动

README.md「使用教程」目录的前两条锚点指向已经被改写的旧标题,点击后不会跳到对应小节:

  • #-方案一docker-部署推荐最简单 → 标题现为「🐳 方案一:Docker 部署(推荐:安全简单)」,真实锚点 #-方案一docker-部署推荐安全简单
  • #-方案二-本地部署 → 标题现为「💻 方案二: 本地部署(推荐项目开发者部署)」,真实锚点 #-方案二-本地部署推荐项目开发者部署

同时修正 README_EN.md 的赞助链接:./docs/sponser.md 不存在,实际文件在 ./docs/md/sponser.md(中文 README 用的正是该路径)。

验证

对照 GitHub 渲染页面输出的标题锚点表逐条核对:改动前这两条锚点都不在表中(即点击无效),改动后 README.md 的 5 条内部链接全部可以解析。

README.md「使用教程」目录里的前两条锚点仍指向旧标题:标题已改为
「方案一:Docker 部署(推荐:安全简单)」和「方案二: 本地部署(推荐项目开发者
部署)」,锚点却没有同步,点击后停在页面顶部。按 GitHub 生成的实际锚点改正。

README_EN.md 的赞助链接写成 ./docs/sponser.md,实际文件位于
./docs/md/sponser.md(中文 README 用的正是该路径),一并修正。
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.

1 participant