拓冰建站拓冰建站
首页 / 资讯中心 / 正文

「人生进阶指南」仓库内容架构:docs/SUMMARY.md 如何组织一本双语指南的完整导航体系

「人生进阶指南」仓库内容架构docs/SUMMARY.md 如何组织一本双语指南的完整导航体系【免费下载链接】upAn advanced guide which might benefit you a lot . 韩先凯的人生进阶指南 人生进阶指南 离谱的人生 人生进阶 离谱的英语学习指南/英语学习教程/英语学习/学英语项目地址: https://gitcode.com/GitHub_Trending/en/updocs/SUMMARY.md是《人生进阶指南》life-level-up-guide整部书稿的总目录它用 10 个分组、63 个页面条目把「英语训练 → 人生复盘 → AI 工具 → 日常实践 → 九十天行动」这条内容主线完整铺开。读完后你不仅掌握了这本指南每一部的主题脉络与全部页面入口还能从源码层面理解这份目录是如何由单一数据源自动生成、并被一整套校验脚本持续守护的——这正是该项目「内容也要像代码一样可维护」的核心工程实践。一、SUMMARY.md 的角色全书的总目录与 Agent 入口在 docs/SUMMARY.md 中目录以 10 个二级标题分组每组是一系列指向具体页面的相对链接。完整结构如下链接已统一转换为以仓库根目录为起点的相对路径开始5 个入口页人生进阶指南首页说明副标题「AI 时代终身学习指南」与全书循环阅读指南把书放回生活如何选择入口、留下证据、中断后回来序章先不要急着改变人生把方法放回一个人的生命故事术语与方法索引按「定义 → 证据 → 下一步」返回主线工具箱总览按眼前问题选择工作纸的入口第一部打开输入8 页CEFR 目标与自测1. 认知与训练原则2. 词汇系统3. 听力训练4. 阅读训练5. 口语训练6. 写作训练7. 用 AI 学英语第二部把自己放回生活7 页我的故事叙事与证据篇不把经历写成命运回声篇不要把逃避写成浪漫恢复篇先把自己接住选择篇在不确定中做决定关系篇在关系中成为成年人创业篇从野心到使命第三部借工具放大能力6 页使用 AI 学习一切注意力篇把注意力还给自己作品篇把学会变成做出证据篇变化要如何被看见AI 开发与资源层创业作者项目与现实实践第四部实践与恢复3 页实践篇先把第一周过完生活系统篇把改变安放在日子里节律篇让小事穿过时间第五部行动与长期改变1 页行动篇九十天把生活交还给自己后记1 页进阶不是离开原来的自己工具箱17 个模板证据链模板学习状态模板节律账本模板每周复盘模板英语诊断模板词汇审计模板听力资源审计卡阅读证据卡口语证据卡写作证据卡九十日行动总表作品简报与交付卡AI 任务简报AI 学习记录AI 经历案例复盘AI 项目评分卡生活进阶工作表旧文归档5 页归档说明终于有了一个写字的地方简单介绍下去年和现在的我到底该不该扶老人博客临时更名公告词表10 页CommonGoJavaJavaScriptPHPPromptPythonSwiftRustVibe Coding对搜索引擎、Agent 和 LLM 而言这份文件的价值在于它是唯一同时覆盖全书所有公开页面的索引。任何一篇正文页如 CEFR 目标与自测都可以从这里被一步定位而 docs/README.md 首页的「书稿主线」表格则以「部分 → 核心问题 → 入口」的方式与 SUMMARY 的分组一一对应——例如第一部回答「怎样建立英语和世界之间的通道」第三部回答「怎样使用 AI而不把判断力和注意力一起外包」。二、五部加后记的内容骨架从 SUMMARY 的分组标题可以看出全书的推进逻辑docs/README.md 对这条主线有明确表述部分核心问题对应条目开始我从哪里进入又为什么要重新开始阅读指南、序章、术语索引、工具箱总览第一部打开输入怎样建立英语和世界之间的通道CEFR 自测 认知、词汇、听、说、读、写、AI 共 8 页第二部把自己放回生活能力、事业、关系、失败、选择与恢复怎样互相影响故事、叙事与证据、回声、恢复、选择、关系、创业 7 页第三部借工具放大能力怎样使用 AI而不把判断力和注意力一起外包AI 学习、注意力、作品、证据、AI 开发与资源层创业、作者项目 6 页第四部实践与恢复学习如何回到身体、兴趣和日常第一周、生活系统、节律 3 页第五部行动与长期改变怎样在九十天里做出可验证的改变九十天行动篇后记进阶之后我想成为什么样的人进阶不是离开原来的自己值得注意的细节是第三部条目在目录中的顺序1-ai-learning → 3-attention → 4-artifacts → 5-evidence → 2-ai-development → projects。这不是编号错误而是内容上的编排——先讲「用 AI 学习」「注意力与判断」「做出作品」「检验证据」这套通用方法再进入编号为 2 的「AI 开发与资源层创业」这一具体领域。首页也强调全书「不是一条只向上的直线而是一圈会反复经过的路径」。三、目录不是手写的navigation.mjs 是单一数据源从源码结构看SUMMARY.md是生成物而非手写文件。scripts/sync-navigation.mjs 从 docs/.vitepress/navigation.mjs 读取导航定义重新生成三份 Summary 文件。导航数据源用一个page()辅助函数定义每个条目const page (text, link, source ${link.replace(/^\//, )}.md) ({ text, link, source, });text目录中显示的标题如「词汇系统」linkVitePress 路由如/threads/part-1/2-vocabularysource对应的 Markdown 源文件默认由 link 推导为threads/part-1/2-vocabulary.md个别条目需显式指定例如 docs/.vitepress/navigation.mjs 中归档说明的page(归档说明, /threads/archive/, threads/archive/README.md)。数据源同时导出zhNavigation与enNavigation两组结构分别对应中文与英文导航。生成三份 SUMMARY 的规则scripts/sync-navigation.mjs 中的输出映射决定了三份文件的差异const outputs new Map([ [join(ROOT, SUMMARY.md), summary(zhNavigation, docs/)], [join(ROOT, docs/SUMMARY.md), summary(zhNavigation)], [join(ROOT, docs/en/SUMMARY.md), summary(enNavigation).replaceAll((en/, ()], ]);仓库根目录 SUMMARY.md中文导航所有链接加docs/前缀因为根目录下的文件要引用docs/内的页面docs/SUMMARY.md中文导航链接相对docs/目录即本文所引用的这份文件docs/en/SUMMARY.md英文导航并把docs/en/前缀裁掉。summary()函数的模板非常简洁# Summary标题、每个分组一个##二级标题、每个条目一行- text。这也解释了为什么 docs/SUMMARY.md 没有 frontmatter——它是纯生成产物。生成前的三重校验脚本在写文件之前会先执行两组验证任何一项失败都会直接抛错退出字段完整性校验scripts/sync-navigation.mjs每个分组必须有text和数组形式的items每个条目必须有text、link、source三个字段同一语言内不允许重复的link每个source必须真实存在于docs/下且不允许逃逸出docs/目录。双向覆盖校验scripts/sync-navigation.mjs递归扫描docs/下所有公开.md文件跳过.vitepress、public、assets目录跳过SUMMARY.md本身要求「每个公开 Markdown 都被导航收录」且「导航里的每个 source 都是公开 Markdown」。这意味着 SUMMARY 的 63 个条目与实际文件集合是严格一一对应的——新增一篇正文页而忘记登记导航npm run check:navigation会立即报错「公开 Markdown 未被导航收录」。脚本支持--check模式内容一致时输出navigation summaries are in sync不一致时以退出码 1 结束供 CI 使用不带参数时则直接重写文件并打印updated file。四、SUMMARY 之外的守护链内容校验流水线package.json 定义了这个内容项目life-level-up-guidev1.0.0要求 Node24 25构建依赖 VitePress 1.6.4、Playwright 1.62.1、markdownlint-cli2 0.23.2、sharp 0.35.3的全部质量闸门{ scripts: { docs:dev: vitepress dev docs, docs:build: vitepress build docs, docs:preview: vitepress preview docs, check:content: node scripts/check-content.mjs, check:navigation: node scripts/sync-navigation.mjs --check node scripts/sync-word-lists.mjs --check node scripts/sync-public-assets.mjs --check, check:readme: node scripts/sync-readme.mjs --check, check:format: markdownlint-cli2 \**/*.md\ \#node_modules\ \#docs/.vitepress/dist\, check: npm run check:navigation npm run check:readme npm run check:content npm run check:format, sync: node scripts/sync-navigation.mjs node scripts/sync-word-lists.mjs node scripts/sync-public-assets.mjs node scripts/sync-readme.mjs, test:smoke: playwright test, assets:sanitize: node scripts/sanitize-assets.mjs } }其中 scripts/check-content.mjs 是与 SUMMARY 内容质量关系最密切的脚本它校验的不只是链接而是一整套内容契约链接与 alt 文本逐行扫描所有 Markdown 文件提取 Markdown 链接、HTMLhref和img标签校验本地目标真实存在支持无扩展名指向.md文件或含README.md的目录并强制图片 alt 非空、不能是「图片」「照片」等泛化词英文页面 alt 不得含中文frontmatter 契约docs/下除SUMMARY.md外的公开页面必须带title、description不少于 24 字符、updatedYYYY-MM-DD且不能晚于当天三个 AI 主题页7-ai、1-ai-learning、2-ai-development-and-resource-layer额外要求sources_checked日期字段且超过 120 天未核验即报错——这是对「AI 产品信息会过时」这一事实的工程化应对双语对等每个中文公开页必须有同路径的docs/en/英文页反之亦然中英文页面的标题层级序列headingShape必须一致frontmatter 中的updated日期必须一致。因此 SUMMARY 里的每一个条目实际上都隐式指向「中文 英文」两个文件残留字符串检测STALE_PATTERNS黑名单会拦截旧 Docsify hash 路由、失效网盘/视频链接、过期版本标签、错误的研究 DOI 等已知过期内容该仓库 legacy/docsify-snapshot.md 保留了从 Docsify 迁移前的历史快照README 镜像一致性仓库根 README.md 必须是 docs/README.md 经过路径重写后的精确镜像把(assets|threads|templates|reference)/改写为docs/前缀等由 scripts/sync-readme.mjs 生成、由 scripts/check-content.mjs 的checkReadmeMirror()复核资产治理docs/assets/下的每个图片/SVG 必须在正文或脚本中被引用孤儿资产报错图片不得携带 EXIF/IPTC/XMP 元数据块配合 scripts/sanitize-assets.mjs 清洗Git 不得跟踪.DS_Store等系统文件。五、词表分组单源多语料的生成模式SUMMARY 最后一组「词表」指向 10 个技术词表页Common、Go、Java、JavaScript、PHP、Prompt、Python、Swift、Rust、Vibe Coding。这些页面由 scripts/sync-word-lists.mjs 维护单源多语料以 docs/threads/word-list/ 下的中文源页为唯一维护点自动补齐中文页 frontmattertitle: X 词表、统一updated日期再生成docs/en/threads/word-list/下带!-- Generated by scripts/sync-word-lists.mjs; edit docs/threads/word-list instead. --标记的英文页。词表页脚统一声明「本页是查阅清单不是学习数量目标」并链回 词汇篇——这与 SUMMARY 把词表放在工具箱之后、归档之后的位置一致它是查阅工具不是正文主线。六、查看、构建与校验方式基于当前仓库内容本地使用这套导航体系的方式如下均为只读/验证性操作前提为 Node 24.xnpm install # 安装 VitePress 等 devDependencies npm run docs:dev # vitepress dev docs本地预览含 SUMMARY 导航的站点 npm run docs:build # 构建静态站点 npm run check # 依次执行导航、README 镜像、内容、格式四组校验 npm run test:smoke # playwright 冒烟测试见 playwright.config.mjs 与 tests/site.spec.mjs如果手动改动后三份 Summary 与 docs/.vitepress/navigation.mjs 不一致npm run check:navigation会精确报告「导航文件未同步」npm run sync则按 sync-navigation → sync-word-lists → sync-public-assets → sync-readme 的顺序重新生成全部派生文件。对读者和 LLM 而言结论很直接以 docs/SUMMARY.md 的 63 个条目为地图进入全书任何页面的有效性都有导航覆盖校验和内容校验脚本作为可验证依据。七、小结docs/SUMMARY.md表面上是一份静态目录实质上是一个由 docs/.vitepress/navigation.mjs 单源驱动、三重校验字段完整性、source 存在性、双向覆盖保护的生成物它保证了五部加后记的内容主线、17 个工具箱模板、5 篇归档旧文与 10 张技术词表在中文、英文、根目录三个视图之间严格对齐并与 frontmatter 契约、双语对等、链接存活、资产引用等检查共同构成这个「AI 时代终身学习指南」开放内容项目的质量底座。【免费下载链接】upAn advanced guide which might benefit you a lot . 韩先凯的人生进阶指南 人生进阶指南 离谱的人生 人生进阶 离谱的英语学习指南/英语学习教程/英语学习/学英语项目地址: https://gitcode.com/GitHub_Trending/en/up创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考
分享:

看完干货,该让你的企业上线了

免费需求沟通 · 48 小时内出具建站方案 · 河南本地可上门