Repository navigation
Releases
v0.7.0 - 清亮主题、搜索收录与知识库审计增强版
本版本是 Azek创游世界文档 继 v0.6.0 - 文档站体验、UI 视觉与维护系统增强版 之后的一次系统升级。
v0.6.0 主要围绕文档站 UI 视觉、文档元信息、维护者信息、链接治理、性能优化、Issue 反馈模板、README 入口和长期维护流程进行增强。本版本在此基础上继续推进,把升级重点从“让文档站更完整、更好看”,进一步扩展到 清亮阅读体验、正式域名 SEO、搜索收录治理、知识库内容审计、无用文档审计、发布前最终巡检和 Cloudflare Pages 自动部署恢复。
本版本的核心目标是:
让 Azek创游世界文档 从“视觉增强型资料库”,进一步升级为“更清亮、更可检索、更可审计、更适合长期维护的创游世界中文知识库”。
版本定位
本次版本不是单纯的 UI 调整,也不是只修几个链接,而是一次偏工程化的资料库升级。
它主要解决这些问题:
- 首页品牌名和站点定位不够稳定。
- 文章页视觉效果较丰富,但长文阅读还可以更清亮、更克制。
- 正式域名、旧域名、默认 pages.dev 域名之间的搜索收录信号需要统一。
- robots、sitemap、canonical 等 SEO 基础信号需要更稳定的自动检查。
- 文档中存在 AI 整理后可能出现的强结论、语气过满、证据不足和术语前后不一致风险。
- 仓库需要一套更安全的无用文档、废弃文档、重复文档和孤儿文档审计流程。
- 发布前需要一套可重复执行的最终巡检流程,降低每次发布时漏检查的风险。
- Cloudflare Pages 自动部署需要重新确认并恢复到 GitHub
main分支自动构建模式。
本版本之后,Azek创游世界文档的长期方向更加明确:
- 资料可导航
- 结论可追溯
- 内容可检索
- 文档可审计
- 发布可复查
- 结构可长期维护
- 更适合玩家学习、资料整理和 AI / RAG 检索
本次重点更新
- 重构首页视觉体验,让首页更清亮、更专业、更像长期维护型文档站入口。
- 修复首页
Azek创游世界文档标题换行问题,避免品牌名被拆成不自然的上下两行。 - 新增首页专用样式层
cysj-home.css,让首页样式和文章阅读样式分离。 - 新增清亮阅读主题覆盖层,优化文章页标题、正文、列表、表格、代码块、引用块、目录、侧边栏和移动端体验。
- 收敛顶部导航结构,将主入口整理为首页、开始阅读、专题资料、维护和关于。
- 将右侧目录层级从 h2-h4 收敛为 h2-h3,减少长文页面目录过深、过密的问题。
- 统一站点公开名称为
Azek创游世界文档。 - 统一正式域名为
https://cysjdocs.azek431.top/。 - 修复 robots.txt、sitemap、canonical、站点标题、站点描述和搜索收录基础信号。
- 新增搜索收录检查脚本,支持源码层和构建产物层双重检查。
- 修复旧域名检查误报,避免检测脚本中的旧域名数组被误判为真实旧域名污染。
- 新增知识库内容审计流程,用于检查强结论、证据不足、AI 味、长句、长段落和潜在事实不一致问题。
- 新增文档语法与真实性审计报告,帮助后续逐篇校对资料准确性。
- 新增无用与废弃文档清理审计流程,用于扫描空壳文件、临时文件、备份文件、重复文档、废弃文档和孤儿文档。
- 更新发布前最终巡检报告,确认构建、sitemap、robots、SEO 检查和线上访问均正常。
- 恢复 Cloudflare Pages 通过 GitHub
main分支自动构建部署。
一、首页与品牌体验升级
本版本对首页进行了比较明显的视觉重构,重点解决首页品牌展示、入口层级和用户第一眼理解成本的问题。
1. 统一首页品牌标题
此前首页标题在部分屏幕宽度下容易把 Azek 和 创游世界文档 拆成两行,视觉上不够自然,也不利于形成稳定的站点品牌。
本版本统一首页主标题为:
Azek创游世界文档
同时通过首页专用样式控制标题字号、宽度、换行和移动端表现,让品牌名在桌面端和手机端都更稳定。
2. 重写首页 Hero 文案
首页 Hero 文案重新整理为更明确的知识库定位:
创游世界脚本、组件、UI 与项目设计知识库
首页说明也从普通介绍改为更具体的资料范围说明,突出以下内容:
- 创游世界脚本教程
- 组件机制
- 变量与广播
- UI 交互
- 项目设计
- 官方教程 OCR
- 引擎更新
- 新手入门路线
- 长期维护规范
这样用户进入首页后,可以更快理解这个站点不是普通博客,而是一个围绕创游世界资料整理、学习和长期维护的知识库。
3. 收敛首页操作按钮
首页操作按钮重新整理为三个核心入口:
- 开始阅读:进入知识库总导航。
- 新手路线:帮助第一次访问的用户快速找到学习顺序。
- GitHub:方便查看仓库、反馈问题和参与维护。
这样首页入口更聚焦,不会让新用户一进来就被大量导航项打散注意力。
4. 重构首页功能卡片
首页功能卡片重新整理为六个核心方向:
- 新手阅读路线
- 脚本与组件系统
- UI 与交互设计
- 项目设计实战
- OCR 与证据资料
- 长期维护规范
这些卡片对应当前资料库的主要内容结构,让首页从“展示页面”进一步变成真正的“知识库导航入口”。
5. 新增首页专用样式
本版本新增首页专用样式层:
docs/.vitepress/theme/styles/cysj-home.css
首页相关的标题、Hero、按钮、卡片、背景氛围和移动端适配不再继续混入通用主题样式中。
这样后续继续优化首页时,不容易误伤文章页阅读体验,也让主题维护边界更清晰。
二、清亮阅读主题升级
本版本继续优化文章页阅读体验,方向不是继续叠加强烈视觉效果,而是让文档更清晰、更克制、更耐读。
1. 文章标题更克制
本版本收敛了文章标题大小和标题间距,减少标题过大带来的压迫感。
优化方向包括:
- h1 更克制,减少首屏占用。
- h2 / h3 层级更清楚,适合长文扫描。
- h4 不再过度干扰目录结构。
- 标题上下间距更适合资料型文章。
- 文章页更强调正文阅读,而不是做成展示型页面。
本版本的阅读方向是:
首页可以有品牌感,文章页优先保证清晰、克制、耐读。
2. 正文阅读体验优化
本版本优化了正文行高、段落间距、列表间距、链接样式和强调文本,让脚本教程、项目设计、OCR 说明、维护报告等不同类型文章都更好读。
优化范围包括:
- 正文段落
- 有序列表
- 无序列表
- 站内链接
- 加粗文本
- 行内代码
- 代码块
- 表格
- 引用块
- 自定义提示块
- 图片展示
3. 表格与代码块优化
创游世界资料库中有大量机制说明、变量说明、证据等级、路线表和维护报告。本版本继续优化表格边框、背景、间距和横向滚动体验,减少移动端表格溢出问题。
代码块和行内代码也继续保持清晰、克制,方便展示命令、路径、配置项和脚本片段。
4. 侧边栏与右侧目录优化
本版本重新收敛导航层级:
- 顶部导航减少过多顶层入口。
- 右侧目录层级收敛到 h2-h3。
- 侧边栏继续保持自动生成。
- 文档底部上一页 / 下一页区域继续保持清晰。
- 移动端阅读布局继续优化。
这让长文页面的导航压力更小,也更适合普通用户按专题阅读。
三、导航结构整理
本版本对顶部导航进行了重新整理。
导航主入口收敛为:
- 首页
- 开始阅读
- 专题资料
- 维护
- 关于
其中“开始阅读”聚合新手阅读路线、快速入门索引、按问题查资料和知识库总导航;“专题资料”聚合脚本系统、项目设计、核心研究、教程资料、OCR 资料和引擎更新;“维护”聚合维护报告、证据规则和内容质量审计相关页面。
这样做的好处是:
- 顶部导航更短。
- 移动端更不容易拥挤。
- 新用户更容易从“开始阅读”进入。
- 老用户可以从“专题资料”直接进入对应方向。
- 维护类内容不再和资料类内容混在一起。
四、正式域名与搜索收录治理
本版本重点修复搜索引擎仍然偏向旧域名、文章页面不容易被发现、不同入口信号不统一的问题。
1. 站点名称统一
本版本将站点公开名称统一为:
Azek创游世界文档
统一范围包括:
- VitePress title
- titleTemplate
- themeConfig.siteTitle
- 首页 frontmatter
- 站点 description
- OG title
- OG description
- Twitter title
- Twitter description
- README 公开说明
- llms.txt 说明
- 站点首页文案
这样可以减少不同页面、不同平台、不同搜索入口显示名称不一致的问题。
2. 正式域名统一
本版本将正式域名统一为:
https://cysjdocs.azek431.top/
并围绕这个域名修复搜索收录信号:
- sitemap hostname 指向正式域名。
- robots.txt 指向正式 sitemap。
- 页面 canonical 指向正式域名。
- OG url 指向正式域名。
- README 入口指向正式文档站。
- 检查脚本检测旧域名残留。
3. canonical 自动生成
本版本在 VitePress 页面数据处理中为页面生成 canonical,避免同一篇文章因为旧域名、默认 pages.dev 域名或不同访问路径造成搜索引擎重复判断。
这对资料库很重要,因为文档站页面数量较多,如果多个域名同时暴露同一份内容,搜索引擎容易把权重分散到旧地址或默认地址。
4. robots 与 sitemap
本版本继续保持 robots.txt 指向正式 sitemap:
User-agent: *
Allow: /
Sitemap: https://cysjdocs.azek431.top/sitemap.xml
本次最终巡检确认构建后的 sitemap 覆盖:
210 个页面
并且线上访问正常:
https://cysjdocs.azek431.top/ 200 OK
https://cysjdocs.azek431.top/sitemap.xml 200 OK
https://cysjdocs.azek431.top/robots.txt 200 OK
五、搜索收录检查脚本
本版本新增搜索收录检查流程,把 SEO 从“手动看配置”升级为“源码层 + 构建产物层双检查”。
1. 源码层检查
新增命令:
pnpm run docs:search-index:check
用于检查源码中的搜索收录基础信号,包括:
- 站点标题是否使用正式名称。
- titleTemplate 是否正确。
- siteTitle 是否正确。
- sitemap hostname 是否指向正式域名。
- robots.txt 是否指向正式 sitemap。
- 是否存在旧域名残留。
- 是否存在不该出现的 noindex。
- Markdown 页面数量是否正常。
- canonical 生成逻辑是否存在。
2. 构建产物层检查
新增命令:
pnpm run docs:search-index:dist
用于检查构建后的真实产物,包括:
sitemap.xml是否存在。robots.txt是否存在。- 首页 HTML 是否存在。
- sitemap URL 数量是否正常。
- 页面 HTML 是否生成 canonical。
- 构建产物是否残留旧域名。
- 构建产物是否出现异常 noindex。
这一步非常重要,因为源码看起来正确,不代表最终构建出来的 HTML、robots 和 sitemap 一定正确。
3. 旧域名误报修复
本版本修复了旧域名检查脚本对 scripts/check-search-indexing.mjs 的误报。
搜索收录检查脚本需要保留旧域名列表,用来检测源码和构建产物里是否还有旧域名残留;但域名检查脚本不应该把这组“用于检测的旧域名数组”当成真实污染。
本版本将搜索收录检查脚本加入旧域名允许列表,保留检测能力,同时避免 docs:domain:check 误报。
六、知识库内容审计与资料校对规则
本版本新增知识库内容深度审计和资料校对规则,核心目标是避免资料型文档出现三个问题:
- 把推测写成确定结论。
- 把经验总结写成官方机制。
- 把 AI 整理出的顺口表达当成真实资料。
1. 资料事实、经验总结和推理模型分层
本版本继续强调资料库内容应该分成三类:
资料事实:
来自截图、OCR、官方教程、引擎更新、界面内容或明确实测记录。
经验总结:
来自整理者使用经验、项目维护经验或多个资料之间的归纳。
推理模型:
为了帮助理解而做的解释、类比、结构化总结或学习路径设计。
这样做的目的不是让文档更复杂,而是避免“看起来很像事实”的内容误导读者。
2. 证据等级思路延续
本项目继续使用证据等级思路:
E1 原始证据
E2 整理证据
E3 研究结论
E4 待验证内容
本版本新增的审计脚本也围绕这个方向继续补强,帮助后续逐步把重点文档补上来源、证据、状态和待验证标记。
3. 强结论审计
本版本特别关注这类词:
必须、一定、只能、不能、无法、官方、支持、不支持、会自动、不会、唯一、最佳、最强
这些词在教程文档里很容易让读者误以为结论已经完全验证。审计脚本会扫描这些强结论,并检查附近是否有 OCR、截图、官方教程、引擎更新、实测、待验证等证据提示。
七、文档语法与真实性审计
本版本新增:
pnpm run docs:truth:audit
用于扫描全站 Markdown 文档中的语法、表达、结构和真实性风险。
1. 检查范围
该脚本会检查:
- frontmatter 是否缺失关键字段。
- 标题层级是否跳跃。
- 是否存在空链接。
- 图片是否缺少 alt。
- 是否存在疑似伪表格。
- 代码块围栏是否闭合。
- 是否出现重复词和重复标点。
- 中文正文中是否混用英文标点。
- 是否存在过长句子和过长段落。
- 标题或正文是否有明显 AI 味或营销化表达。
- 强结论附近是否缺少证据提示。
- 提到官方教程、引擎更新、版本号时是否缺少来源提示。
- 同一术语是否同时出现“支持 / 不支持”“可以 / 不能”等潜在正反描述。
2. 本次最终审计结果
本次发布前运行结果显示:
checked 197 markdown file(s)
found 987 issue(s)
possible contradiction terms: 21
这些结果不代表有 987 个事实错误,而是说明当前资料库中仍有大量内容值得后续人工复核,包括:
- 表达过强
- 证据提示不足
- 句子过长
- 标题偏 AI 味
- 部分术语可能前后描述不一致
- 部分报告内容可能被链接检查误识别
本版本不会自动改写这些事实类内容,而是先生成报告,作为后续逐篇校对的路线图。
3. 为什么不自动批量改事实
资料型知识库最怕“把错误改得更自然”。
所以本版本的真实性审计只做定位,不自动改写结论。
后续处理原则是:
先找问题
再找来源
再降语气
再补证据
最后才改正文
八、无用与废弃文档清理审计
本版本新增:
pnpm run docs:prune:audit
用于扫描文档站中疑似无用、废弃、临时、重复、空壳和孤儿 Markdown 文件。
1. 清理策略
本版本采用安全清理策略:
- 只把高置信废弃文件列为可删除对象。
- 对普通孤儿文档只列入人工复核,不默认删除。
- 自动保护首页、关于页、总导航、维护导航等关键入口。
- 自动保护 OCR、证据、官方、原始资料相关内容。
- 对仍被引用的废弃文档不自动删除,避免导航或链接断裂。
- 生成 Markdown 报告和 JSON 清单,方便检查与回滚。
2. 本次最终审计结果
本次发布前运行结果显示:
scanned markdown files: 210
candidates: 6
high-confidence deletable: 0
这说明当前仓库没有明显可以直接删除的高置信废弃文档。少量候选项需要人工复核,但不应该在发行版前激进删除。
这也是本版本比较重要的结论:
当前资料库虽然仍有内容质量和链接 WARN,但没有发现适合直接批量删除的高风险废弃文件。
九、自动化维护流程增强
本版本继续加强自动化维护能力,让资料库更适合长期维护,而不是每次靠人工翻文件。
1. 当前关键维护命令
本版本重点确认和使用的命令包括:
pnpm run quality:check
pnpm run docs:check:light
pnpm run docs:search-index:check
pnpm run docs:search-index:dist
pnpm run docs:truth:audit
pnpm run docs:prune:audit
pnpm run docs:build
这些命令覆盖:
- UI 关键文件检查
- 正式域名检查
- CSS 健康检查
- 轻量链接检查
- 仓库健康巡检
- 搜索收录源码检查
- 搜索收录构建产物检查
- 文档语法与真实性审计
- 无用与废弃文档审计
- VitePress 正式构建
2. 发布前最终巡检
本版本发布前已完成最终巡检:
quality:check 通过
docs:check:light 通过
docs:search-index:check 通过
docs:build 构建成功
docs:search-index:dist 通过
docs:truth:audit 已生成报告
docs:prune:audit 已生成报告
git diff --check 无格式错误
构建结果显示:
Sitemap URL count: 210
Dist SEO check scanned 210 html file(s)
Search indexing check passed (dist)
线上检查结果显示:
https://cysjdocs.azek431.top/ 200 OK
https://cysjdocs.azek431.top/sitemap.xml 200 OK
https://cysjdocs.azek431.top/robots.txt 200 OK
这说明本版本已经完成发布前基础验证。
十、Cloudflare Pages 自动部署恢复
本版本重新确认并恢复 Cloudflare Pages 通过 GitHub main 分支自动构建部署。
当前推荐配置为:
Production branch:
main
Build command:
pnpm run docs:build
Build output directory:
docs/.vitepress/dist
这次也修正了部署配置中容易出错的一点:
- VitePress 站点目录在
docs/ - 构建命令是
pnpm run docs:build - 最终输出目录不是
.vitepress/dist - 正确输出目录应该是
docs/.vitepress/dist
后续发布流程恢复为:
本地修改
→ VS Code 提交
→ Push 到 GitHub
→ Cloudflare Pages 自动构建
→ cysjdocs.azek431.top 自动更新
十一、README 与项目入口同步
本版本继续保持 README 作为项目入口的定位。
README 当前强调:
- 在线文档站优先访问。
- GitHub 仓库用于查看源码、反馈问题和参与维护。
- Gitee 作为镜像入口。
- 资料库覆盖脚本、组件、变量广播、UI、项目设计、OCR、官方教程、引擎更新和维护报告。
- 项目目标是可导航、可追溯、可检索、可维护,并适合 AI 检索。
- 维护原则强调不随意删除原始资料、不把待验证内容写死、重要结论尽量有关联来源。
本版本新增的 SEO、真实性审计、废弃文档审计和最终巡检,都是围绕这些 README 维护原则继续补强。
十二、本版本对用户的实际影响
1. 对普通读者
- 首页更清楚,进入资料库后更容易知道从哪里开始。
- 新手可以更快进入阅读路线。
- 想查脚本、UI、组件、项目设计、OCR 资料的用户更容易找到入口。
- 文章页阅读压力降低,标题、正文、表格和目录更清晰。
2. 对资料查找者
- 正式域名、sitemap、robots、canonical 信号更统一。
- 后续搜索引擎更容易重新发现正式域名页面。
- 资料分类、导航入口和...
v0.6.0 - 文档站体验、UI 视觉与维护系统增强版
本版本是「创游世界资料库」继 v0.5.0 - 文档站视觉升级与仓库清理版 之后的进一步体验增强版本。
v0.5.0 重点完成了文档站主样式统一、旧样式清理、仓库结构整理、侧边栏刷新、llms.txt、frontmatter 检查、UI 检查和构建验证。本版本在此基础上,继续围绕 全站 UI 氛围、文档元信息、维护者信息、搜索与链接治理、性能优化、Issue 反馈模板、README 项目入口和长期维护流程 做了一轮系统增强。
本版本的目标是让创游世界资料库从“更好看的文档站”继续升级为“更稳定、更专业、更适合长期维护和用户反馈的中文知识库产品”。
本次重点更新
- 深度优化 VitePress 文档站整体 UI 视觉体验。
- 新增终极 UI 视觉优化样式层,增强首页、功能卡片、按钮、表格、引用块、代码块、侧边栏、右侧目录、滚动条、深色模式和移动端体验。
- 新增全站氛围增强样式层,让渐变背景、玻璃感、正文卡片层次贯穿首页、文档页、侧边栏和页脚。
- 优化首页中间 Markdown 区域,让首页不再只是普通文档正文,而更像资料库控制台。
- 优化文档正文阅读体验,为文档主体增加更统一的视觉层次和柔和背景。
- 增强文档顶部元信息系统,支持写作日期、更新日期、字数、阅读时间、维护者、状态、难度和证据等级。
- 自动补全文档写作日期和更新日期,统一文档元数据。
- 支持日期悬浮显示更精确的时间信息。
- 增加维护者悬浮信息卡片,展示 GitHub、Gitee、Telegram、QQ 群等维护者信息。
- 清理正文中重复、错误或 AI 自动生成的更新时间脚注。
- 新增 Markdown 站内链接修复脚本,自动处理链接中空格导致的解析异常。
- 新增文档内容质量审计脚本,用于检查缺失 frontmatter、空链接、仓库路径、超长段落、标题层级跳跃等问题。
- 增强搜索引擎抓取配置,优化 robots.txt、sitemap、SEO 元信息和站点搜索友好度。
- 排除历史归档、自动目录、审计报告等低价值页面进入本地搜索索引。
- 增加 Cloudflare Pages 缓存规则和构建体积审计脚本,提升二次访问和后续性能定位能力。
- 新增 GitHub Issue 表单模板,方便用户反馈文档错误、失效链接、OCR 修正、资料建议和站点体验问题。
- 深度重构 README,让 GitHub 仓库首页更清晰、更像项目入口。
- 新增或完善内容质量审计、OCR 当前状态、导航体系说明等维护入口。
- 继续强化资料库“可导航、可追溯、可检索、可维护”的长期定位。
UI 与视觉体验增强
本版本对文档站视觉做了进一步打磨。
首页体验
- 首页 Hero 区域更有视觉中心和品牌感。
- 功能卡片增加更统一的圆角、阴影、渐变、hover 反馈和玻璃质感。
- 首页中间正文区域增加卡片化背景、连续渐变氛围和控制台式视觉层次。
- 推荐阅读路径、资料可信度说明、快速入口等内容更清晰。
- 页面整体从“普通 VitePress 文档首页”进一步升级为“创游世界资料库知识控制台”。
文档页体验
- 文档主体区域增加柔和玻璃卡片背景和渐变氛围。
- 标题层级、段落、列表、表格、引用块、代码块和分割线进一步优化。
- 元信息栏采用标签化展示,视觉上更接近正式知识库系统。
- 维护者信息支持悬浮卡片展示,增强开源项目可信度和联系入口。
- 深色模式下背景、卡片、文字、边框和阴影更统一。
导航与移动端体验
- 顶部导航、侧边栏、右侧目录、上一页/下一页、页脚细节继续优化。
- Gitee 镜像仓库入口和图标显示更明确。
- 移动端按钮、表格、正文卡片和页面背景做了适配,避免拥挤和溢出。
- 支持低动画偏好,减少对动画敏感用户的不适。
文档元信息系统
本版本重点增强了每篇文档的顶部信息栏。
现在文档可以展示:
- 写作日期
- 更新日期
- 字数统计
- 阅读时间
- 维护者
- 状态
- 难度
- 证据等级
其中:
- 写作日期优先来自
created/createdAt - 更新日期优先来自
updated/updatedAt - 日期在页面上简洁显示,鼠标悬浮时显示更精确时间
- 维护者支持悬浮卡片,展示 GitHub、Gitee、Telegram 和 QQ 群等信息
这让文档从普通 Markdown 页面更接近正式知识库文章。
内容治理与自动化维护
本版本新增和优化了多种维护脚本,使文档维护更加自动化:
- 站内链接空格修复脚本
- AI 更新时间脚注清理脚本
- 写作日期与更新日期同步脚本
- 文档内容质量审计脚本
- 搜索索引排除脚本
- 构建体积审计脚本
- 一键部署检查脚本
- UI 检查脚本增强
这些脚本可以帮助维护者快速发现和处理:
- 错误链接
- 空链接
- 过期日期
- 重复更新时间
- 缺失 frontmatter
- 超长段落
- 标题层级异常
- 历史归档干扰搜索
- 构建产物和缓存问题
维护方式从“逐篇手工检查”进一步升级为:
自动扫描 → 自动修复 → 人工确认 → 轻量检查 → 提交发布
搜索、SEO 与浏览性能
本版本继续增强搜索和性能体验:
- 修复站内链接中空格导致的 Markdown 链接解析异常。
- 优化 robots.txt 和 sitemap 配置,提升搜索引擎抓取友好度。
- 保留 VitePress 静态站点优势,继续支持搜索引擎读取页面正文。
- 排除历史归档、自动目录和审计报告等维护页面进入本地搜索索引。
- 添加 Cloudflare Pages
_headers缓存规则,提高静态资源二次访问速度。 - 增加构建体积审计脚本,为后续定位大 JS、搜索索引和资源体积问题打基础。
开源协作与反馈机制
本版本新增 GitHub Issue Forms,用于规范用户反馈。
目前支持:
- 文档内容错误反馈
- 失效链接 / 404 反馈
- OCR 资料修正
- 新资料 / 新专题建议
- 文档站体验问题
这样用户可以按模板提交页面链接、问题类型、建议修改、证据来源和截图说明,让反馈更容易处理。
README 与仓库入口优化
本版本继续优化 README,使 GitHub 仓库首页更清晰:
- 强化在线文档站入口
- 增加 GitHub / Gitee 镜像入口
- 明确项目简介、适合人群和仓库亮点
- 补充推荐阅读路线
- 补充本地运行、日常维护、一键部署检查说明
- 补充仓库结构、内容分类、证据等级、维护原则和贡献建议
- 增加 GitHub Issues 反馈入口
现在 README 不只是说明文件,也更像项目门户。
内容结构与资料库治理
本版本继续完善资料库治理体系:
- 优化首页资料入口
- 完善“按问题查资料”
- 完善“资料证据等级说明”
- 完善“OCR 当前状态与待补清单”
- 完善“内容质量审计清单”
- 完善“导航体系说明”
- 清理和归档部分历史报告、备份文件、冲突文件和临时文件
- 强化
.gitignore/.stignore,减少 Syncthing 冲突文件和构建产物进入仓库
项目继续从“资料集合”升级为:
有入口、有证据、有状态、有审计、有反馈、有维护流程的中文资料库系统。
本地验证
本版本建议至少通过以下检查:
pnpm run docs:frontmatter:check
pnpm run docs:ui:checkv0.5.0 - 文档站视觉升级与仓库清理版
本版本围绕「创游世界资料库」的文档站视觉体验、主题结构、仓库清理、导航维护和长期工程化管理进行了一轮系统优化。
在上一版 v0.4.0 已经完成自动目录、侧边栏、内容扩展和多平台发布流程增强的基础上,本版本进一步聚焦「更好看、更干净、更稳定、更适合长期维护」的目标,让文档站从“能用的资料库”继续向“专业化中文知识库”演进。
本次重点更新
- 统一 VitePress 文档站主题样式,新增并启用
cysj-pro.css作为主样式文件。 - 优化首页、功能卡片、正文排版、表格、引用块、代码块、深色模式等视觉体验。
- 清理旧版主题样式文件,减少多套 CSS 叠加带来的维护混乱。
- 优化
.gitignore与同步忽略规则,减少本地备份、构建产物、Syncthing 冲突文件进入仓库的风险。 - 更新文档 UI 检查脚本,确保主题入口、布局组件、页面信息组件、操作组件、主样式文件和静态资源完整。
- 新增
llms.txt,提升 AI 检索、搜索工具和后续知识库索引的可理解性。 - 重新生成 VitePress 自动侧边栏与自动文档目录,增强文档导航体验。
- 调整部分文档结构,让格式示例、错误优化清单等内容归入更合适的维护分类。
- 完成本地 frontmatter 检查、UI 检查与 VitePress 构建验证。
UI 与阅读体验优化
本版本重点提升了文档站的整体观感:
- 首页 Hero 区域更加清爽、有层次感。
- 功能卡片增加更统一的圆角、阴影、渐变和 hover 反馈。
- 正文标题、段落、列表、表格、引用块和代码块的阅读体验进一步优化。
- 深色模式下的背景、卡片和文字对比度更加统一。
- 页面整体风格从“普通文档页”进一步升级为“现代化资料库界面”。
整体方向是:减少杂乱样式堆叠,保留清爽、现代、专业的中文知识库视觉体验。
仓库清理与结构整理
本版本对仓库中容易造成维护混乱的内容进行了清理和整理:
- 移除旧版 UI 样式文件,统一由新的主样式文件负责视觉覆盖。
- 清理本地备份、临时文件、冲突文件和构建缓存相关内容。
- 加强
.gitignore,避免后续重复提交无意义文件。 - 保留原始资料目录,不破坏资料追溯链路。
- 更新 UI 检查脚本,使后续维护时可以快速判断关键文件是否完整。
这一步让仓库结构更清晰,也让后续继续扩写文档、优化主题、发布版本时更稳定。
自动化与维护改进
本版本继续强化文档站的工程化维护能力:
pnpm run docs:frontmatter:check检查通过。pnpm run docs:ui:check检查通过。pnpm run docs:sidebar成功重新生成侧边栏与自动目录。pnpm run docs:build构建成功。
本次验证说明当前文档结构、主题入口、UI 组件和 VitePress 构建流程可以正常工作。
当前项目定位
「创游世界资料库」仍然保持以下长期目标:
- 资料可导航
- 结论可追溯
- 内容可检索
- 结构可维护
- 适合玩家学习
- 适合 AI 检索与知识库构建
本版本主要不是单纯增加资料数量,而是提升整个资料库的质量、稳定性和专业观感。
已知说明
- 部分 OCR、专题研究和证据链内容仍处于整理、复核和持续完善阶段。
- 文档站后续仍会继续优化首页信息层级、SEO、搜索体验和内容分类。
- 如果使用 Syncthing 同步项目目录,建议继续忽略构建产物、缓存目录和临时文件,避免 Windows 下出现文件占用或权限冲突。
后续计划
- 继续优化首页,使其更像“创游世界知识库控制台”。
- 继续完善脚本系统、组件机制、变量广播、UI 交互和项目设计专题。
- 继续补齐 OCR 资料、编号映射、证据等级和待验证清单。
- 继续增强 SEO、站点搜索、AI 检索友好度和多平台发布流程。
- 后续考虑进一步优化构建体积、代码分包和文档站加载性能。
本地验证
本版本已通过以下命令验证:
pnpm run docs:frontmatter:check
pnpm run docs:ui:check
pnpm run docs:buildv0.4.0 文档站结构增强与自动化维护版
本次版本围绕「创游世界资料库」的阅读体验、自动化维护、内容扩展和长期检索能力进行了一轮系统升级。项目继续保持“可导航、可追溯、可检索、可持续扩写”的知识库定位,面向创游世界玩家、脚本学习者、项目创作者、资料整理者和 AI 检索场景,持续整理脚本、组件、UI、项目设计、OCR 证据、教程资料与维护规范。
本次重点更新
- 新增自动生成文档目录与 VitePress 侧边栏能力,减少新增文档后手动维护目录的成本。
- 优化首页、主题样式和文档阅读体验,新增更轻量的页面信息栏、站点工具与底部参与维护入口。
- 新增和扩展创游世界数据持久化、存档设计、项目维护、代码组织等实战类文档。
- 新增 GitHub Release 同步到 Gitee Release 的自动化工作流,为后续多平台发布打基础。
- 修复部分 Markdown 代码块语言标记问题,将未知语言标记统一回退为
txt,减少 VitePress 开发时的高亮警告。 - 优化本地开发脚本,固定开发服务端口,提升多设备预览和本地调试体验。
内容建设方向
本版本进一步强化了脚本系统、项目设计、OCR 资料和维护报告之间的关联关系。资料库不再只是单纯堆放文档,而是逐步向“新手可阅读、专题可查找、证据可追溯、AI 可检索”的结构化知识库演进。
自动化与维护改进
本次引入的自动目录生成、Gitee 发布同步、开发脚本优化和文档格式修复,为后续持续扩写提供了更稳定的基础。之后新增文档时,可以通过脚本自动刷新目录与侧边栏,再进行构建检查和版本发布,整体维护流程更加清晰。
已知说明
- 部分 OCR 与专题内容仍处于整理、复核和待验证阶段。
- 部分文档仍会继续补充来源说明、回链、关键词和证据等级。
- Gitee 发行版同步依赖 GitHub Actions 与 Gitee Token 配置,首次使用前需要确认 Secrets 和镜像同步状态。
后续计划
- 继续补齐创游世界脚本教程、组件机制、变量广播、项目设计和新手学习路线。
- 继续完善官方教程截图 OCR、证据链、编号映射和待复核清单。
- 继续优化 SEO、站点导航、搜索入口页和 AI 检索友好度。
- 持续完善 GitHub / Gitee 多平台发布流程。
v0.3.0 - AI 文档工程与自动目录增强版
这是 cysj-data 的第三个正式发布版本。
本版本重点从“阅读体验优化”进一步升级为“AI 文档工程化维护”。在上一版 v0.2.0 完成文档站 UI 轻量化、顶部元信息栏、底部维护入口和阅读体验优化的基础上,本版本进一步引入自动目录生成、AI 自动文档建设报告、后续研究路线图、待验证问题清单、FAQ/避坑内容、组件与编辑器基础专题等内容,使资料库更适合长期扩写、AI 检索、结构化维护和 VitePress 文档站持续迭代。
本次重点
- 新增 AI 自动化文档建设报告,用于记录 AI 辅助整理、扩写、优化文档的过程与结果。
- 新增后续研究路线图,用于规划资料库中长期内容补齐、专题扩展和研究方向。
- 新增待验证问题清单,用于统一收集需要进一步核实、补充证据或人工复核的问题。
- 新增自动侧边栏与自动目录生成脚本,可根据
docs目录结构自动生成 VitePress 侧边栏和文档目录页。 - 新增或强化知识库总索引,让用户能更容易从全局理解资料库结构。
- 新增创游世界新手常见问题快速查询内容,降低新用户查找成本。
- 新增或优化常见问题与避坑指南,提升资料库的实用性。
- 新增组件添加界面深度解析,进一步补齐脚本系统和组件体系相关资料。
- 新增创游世界编辑器基础入门,帮助新手理解编辑器核心功能。
- 批量优化文档 frontmatter、元数据和前言结构,提高 SEO、搜索和 AI 检索友好度。
- 更新自动生成文档目录,修复部分链接冲突,并补充必要文档条目。
新增内容
AI 文档工程
本版本新增了面向长期维护的 AI 文档建设记录体系,用于沉淀 AI 参与资料整理、文档补全、结构优化、报告生成和后续规划的过程。
新增内容包括:
- AI 自动文档建设报告
- 后续研究路线图
- 待验证问题清单
- 自动生成文档目录
- 自动侧边栏生成脚本
这些内容让资料库不再只是静态文档集合,而是逐步形成“扫描 → 整理 → 补齐 → 审计 → 优化 → 生成报告”的持续维护流程。
自动目录与侧边栏
本版本新增 scripts/generate-sidebar.mjs,用于自动扫描 docs 目录中的 Markdown 文件,并生成:
- VitePress 自动侧边栏配置
- 自动生成文档目录页面
这样以后新增文档后,不需要每次手动维护目录,只需要运行:
pnpm run docs:sidebarv0.2.0 - 阅读体验与 UI 优化版
这是 cysj-data 的第二个正式发布版本。
本版本重点优化了创游世界资料库文档站的阅读体验,将原本较大的文档档案卡、站点工具卡和底部参与维护卡片,调整为更简洁、更克制、更适合长期阅读的文档站 UI。整体方向从“展示型大卡片”转向“正文优先、信息辅助、操作轻量”的专业知识库风格。
本次重点
- 优化文档顶部元信息展示方式。
- 将原来的大块“文档档案 / Knowledge Profile”改为一行式文档信息栏。
- 新增写作日期、字数、阅读时间、最后更新、维护者等更直观的信息展示。
- 移除右侧大块站点工具卡,减少对正文阅读的干扰。
- 将底部“参与维护”区域改为轻量操作栏。
- 保留编辑此页、反馈建议、复制链接、GitHub 入口等维护操作。
- 继续优化 VitePress 主题结构与 UI 覆盖层。
- 增加并更新文档 UI 检查脚本,方便后续快速检测主题文件是否完整。
UI 优化
文档顶部
原来的文档档案卡视觉较重,占用空间较大。
本版本将其改为更简洁的一行式元信息栏:
- 写作日期
- 文档字数
- 阅读时间
- 最后更新
- 维护者
这样可以让用户快速了解文档状态,同时不会影响正文阅读。
右侧区域
移除了右侧“站点工具”卡片,避免遮挡视野或干扰目录阅读。
后续如果恢复工具入口,会优先采用更轻量的方式,例如顶部链接、底部入口或独立导航页。
底部参与维护
底部维护区域从大卡片调整为轻量操作栏,保留:
- 编辑此页
- 反馈建议
- 复制链接
- GitHub 仓库入口
这样既保留了协作入口,又不会破坏页面整体阅读节奏。
工程优化
- 新增或更新
minimal-doc-ui.css,用于覆盖旧版较重的 UI 样式。 - 更新
PageInfo.vue,实现轻量文档元信息展示。 - 更新
PageActions.vue,实现简洁的底部维护操作栏。 - 更新
Layout.vue,移除右侧站点工具插槽。 - 更新
check-docs-ui.mjs,检查关键主题文件、UI 样式文件和静态资源文件是否存在。 - 保持
docs/.vitepress/dist、.temp、cache等构建产物不进入 Git 跟踪。
当前部署信息
- 文档框架:VitePress
- 托管平台:Cloudflare Pages
- 源码仓库:GitHub
- 生产分支:
main - 构建命令:
pnpm run docs:build - 构建输出目录:
docs/.vitepress/dist - 当前线上站点:
https://cysjdocs.dpdns.org/
本地验证
本版本在本地通过以下流程验证:
pnpm run docs:ui:check
pnpm run docs:build
pnpm run docs:previewv0.1.0 - 创游世界资料库初始发布版
这是 cysj-data 的第一个正式发布版本。
本版本完成了创游世界资料库从本地文档整理到在线文档站的初步搭建,确认 VitePress 本地构建、GitHub 仓库管理和 Cloudflare Pages 自动部署流程均可正常运行。
本次重点
- 首次发布可在线访问的创游世界资料库文档站。
- 完成 GitHub + Cloudflare Pages 自动部署流程。
- 确认标准构建输出目录为
docs/.vitepress/dist。 - 清理旧的构建产物,避免将生成后的网页文件提交进仓库。
- 优化
.gitignore,排除node_modules、VitePress 缓存、构建产物和 Syncthing 冲突文件。
本次修复
- 修复 Cloudflare Pages 构建失败问题。
- 移除旧的
site-dist构建产物跟踪。 - 删除不再使用的
pnpm-workspace.yaml。 - 确认本地
pnpm run docs:build可以成功构建。 - 确认本地
pnpm run docs:preview可以正常预览文档站。
当前部署信息
- 文档框架:VitePress
- 托管平台:Cloudflare Pages
- 源码仓库:GitHub
- 生产分支:
main - 构建命令:
pnpm run docs:build - 构建输出目录:
docs/.vitepress/dist - Node.js 版本:
24.15.0 - pnpm 版本:
10.33.3
当前访问方式
- Cloudflare Pages 默认地址:
https://cysjdocs.pages.dev - 自定义域名:后续计划绑定
cysjdocs.dpdns.org
已知说明
- 本版本是首个在线文档站版本,资料结构仍会继续优化。
- 部分资料仍处于整理、OCR 转写、专题归纳和待验证阶段。
- 后续版本会继续完善导航、搜索体验、SEO 信息、专题文档和阅读路线。
后续计划
- 继续完善总索引与新手阅读路线。
- 优化文档分类、命名规范和导航结构。
- 补充更多创游世界脚本、组件、UI、对象结构和引擎更新资料。
- 绑定自定义域名并持续优化站点访问体验。