docs(manual): 发布 MyKnowledge 使用手册教学页到 GitHub Pages - #7
Merged
Conversation
新增 docs/manual/index.html —— 面向最终用户的图文使用手册(安装 / 使用 / FAQ
三大板块 + 21 张内嵌截图)。源文件是本地 file:// 打开的单页 HTML,处理如下:
- 资源全自包含:21 张截图均为 data:image base64 内嵌,CSS/JS 全部 inline,
无任何本地绝对路径 / file:// / 外链资源依赖(唯一外链是仓库 GitHub 主页)。
- 补齐文档骨架:原文件缺 <!doctype>/<html>/<head>/<body>,包进标准骨架进入
标准模式(* { box-sizing: border-box } 已全局设置,无布局漂移风险)。
- 4 个页内锚点(#top/#install/#usage/#faq)均已校验指向真实 id。
发布方案:新增 .github/workflows/pages.yml,只把 docs/manual/ 这一个目录作为
Pages 站点根发布(actions/upload-pages-artifact path: docs/manual)。
理由:
- 仓库此前未启用 Pages(API has_pages=false,无 gh-pages 分支,无 Pages workflow)。
- 用 Actions 而非 "main 分支 /docs 目录":docs/ 下有 50+ 内部设计文档 / 任务
笔记 / 中文目录,走 /docs 会被 Jekyll 整体处理(易失败)并把内部文档一并
публиш。只发 docs/manual/ 完全隔离,不动现有 docs/ 结构。
- configure-pages enablement:true 首次运行自动开启 Pages(源=GitHub Actions)。
合并到 main 后访问:https://codermoray.github.io/MyKnowledgePlatform/
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01SSMDrsmrXR5kr68SUS5D5P
导航结构: - 顶栏胶囊链接(安装/使用/FAQ)→ 左侧固定侧边栏(桌面竖排、窄屏顶部横排)。 点击切换右侧内容区显示对应板块,纯 CSS/JS 单文件实现,不刷新页面、不新增文件。 当前板块高亮;同步 URL hash,支持 #install/#usage/#faq 深链、浏览器前进后退、 Hero 两个 CTA 按钮也走同一套切换。 - Hero 始终显示在内容区顶部;切换板块滚动到内容区(不强制滚过 Hero)。 图文布局(安装步骤 + 使用场景): - 原左右两列并排 → 每个步骤单独占一行竖排。 - 行内:左截图 55% / 右文字 45%,图文垂直居中;窄屏(≤780px)堆叠成上图下文。 - 使用场景取消 .reverse 交替,统一图左文右。 - .substeps 改 grid minmax(0,1fr) 单列,防止长命令行把页面撑宽(窄屏零横向溢出,375–1440px 实测)。 - 2.7 的「复制系统提示词」按钮从 .substep-head 内提到独立一行,num 徽标回到与首行文字同行。 其它: - 锚点 #install/#usage/#faq 全部有效,改版后跳转 = 切换板块。 - 内联空 favicon,消除浏览器 /favicon.ico 404(页面仍完全自包含)。 - 所有正文文字与 21 张内嵌截图逐字节不变,只改布局与导航结构。 本地 http.server 验证:三板块切换正常、图文 55/45 且居中、窄屏堆叠、 深链/hero CTA/hash 同步正常、无控制台报错。 Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01SSMDrsmrXR5kr68SUS5D5P
CoderMoray
approved these changes
Sep 3, 2026
CoderMoray
left a comment
Owner
There was a problem hiding this comment.
已审查:HTML 自包含无外链/本地路径,Pages workflow 发布方案合理,测试通过。LGTM
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
新增 docs/manual/index.html —— 面向最终用户的图文使用手册(安装 / 使用 / FAQ 三大板块 + 21 张内嵌截图)。源文件是本地 file:// 打开的单页 HTML,处理如下:
发布方案:新增 .github/workflows/pages.yml,只把 docs/manual/ 这一个目录作为 Pages 站点根发布(actions/upload-pages-artifact path: docs/manual)。
理由:
合并到 main 后访问:https://codermoray.github.io/MyKnowledgePlatform/
Claude-Session: https://claude.ai/code/session_01SSMDrsmrXR5kr68SUS5D5P