Skip to content

docs: 增加 GitHub Pages 文档页导航#30

Merged
MarsonShine merged 1 commit into
masterfrom
refactor/framework-optimization-from-review
Jun 25, 2026
Merged

docs: 增加 GitHub Pages 文档页导航#30
MarsonShine merged 1 commit into
masterfrom
refactor/framework-optimization-from-review

Conversation

@MarsonShine

Copy link
Copy Markdown
Owner

Why

GitHub Pages 现在把 docs/ 下的文章渲染成彼此独立的 Cayman 页面。从首页进入后可以看到单篇内容,但缺少继续阅读的活导航,文档之间基本是断开的。

What changed

  • 覆盖 Cayman 默认布局,在所有 docs/ 页面上统一加入共享导航区
  • 为文档页增加返回 docs/ 文档中心、本主题目录、项目首页的入口
  • 为同目录文档增加“继续阅读”链接,以及上一篇 / 下一篇链接,这样现有文档不用逐篇补 front matter 或手工互链
  • 在仓库首页的“文档入口”里补上“文档中心总览”入口

Notes

  • 保持 GitHub Pages 原生 Jekyll 方案,没有加插件,也没有逐篇改文档
  • 当前上一篇 / 下一篇按同目录路径排序;如果后面需要严格的人工阅读顺序,再补显式顺序数据即可

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings June 25, 2026 04:46
@MarsonShine MarsonShine merged commit 9cc957a into master Jun 25, 2026
1 of 2 checks passed

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

该 PR 通过覆盖 Cayman 主题的默认布局,为 GitHub Pages 上 docs/ 目录下的文档页增加统一的共享导航区,从而让文档之间具备可持续浏览的“继续阅读 / 上一篇 / 下一篇”跳转能力,并在仓库首页补充文档中心入口,提升文档站的可用性与连贯性。

Changes:

  • 新增 _layouts/default.html 覆盖 Cayman 默认布局:在 docs/ 页面顶部加入“文档中心 / 本主题目录 / 项目首页”导航,并在页面底部加入上一篇/下一篇翻页。
  • 基于同目录页面(按路径排序)自动生成“继续阅读”链接,无需逐篇补 front matter 或手工互链。
  • README 的“文档入口”新增“文档中心总览”链接。

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
README.md 在仓库首页补充“文档中心总览”入口,方便从首页进入文档中心。
_layouts/default.html 覆盖 Cayman 默认布局,为 docs/ 文档页注入共享导航与上一篇/下一篇翻页能力。

Comment thread _layouts/default.html
Comment on lines +7 to +9
<link rel="preconnect" href="https://fonts.gstatic.com">
<link rel="preload" href="https://fonts.googleapis.com/css?family=Open+Sans:400,700&display=swap" as="style" type="text/css" crossorigin>
<meta name="viewport" content="width=device-width, initial-scale=1">
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