Skip to content

Latest commit

 

History

History
72 lines (47 loc) · 3.62 KB

maintenance.md

File metadata and controls

72 lines (47 loc) · 3.62 KB
title 内容与站点维护
description 单一 Markdown 来源、预览与构建、图表生成、检查与旧内容存档说明。
search false

内容与站点维护

知识正文在 knowledge/,站点直接读取这些 Markdown。不要手改构建产物。普通阅读从学习路线开始,本页面向希望修改内容或本地运行站点的人。

本地运行

需要 Node.js 22+;当前在 Node.js 24 环境完成构建。首次安装后可离线阅读已构建站点,外部论文链接需要网络。

在仓库根目录执行:

npm ci
npm run docs:dev

终端会打印本地地址。开发模式用于编辑时即时刷新;静态发布产物使用:

npm run docs:check
npm run docs:build
npm run docs:check-built
npm run docs:preview

总网页入口为 knowledge/.vitepress/dist/index.html。请通过本地 HTTP 服务阅读,不直接双击构建 HTML;站点包含模块脚本与路由资源。可以把整个 dist/ 目录交给静态服务器,不能只复制其中一个 HTML。

子路径部署时,在构建前设置 DOCS_BASE,例如 PowerShell:

$env:DOCS_BASE = '/Note/'
npm run docs:build
Remove-Item Env:DOCS_BASE

当前流程只生成本地站点;发布与远程部署不在此列。

新增或修改页面

每篇使用一个 H1、清晰的二三级标题、相对 .md 链接,并在 frontmatter 写 title、description 和可选 tags。模块内新增文件及嵌套目录会被导航发现;希望调整教学顺序与专题名称时修改 knowledge/.vitepress/config.mjs 的 chapters 与 subchapters。

正文优先讲清问题、机制、假设与例子,不机械套固定模板。关键公式说明变量;算例标清单位;伪代码不冒充可运行程序。参考链接集中在页末短区域,通常保持可见篇幅的约 5% 以内。

有版本差异时,在涉及行为的位置写明版本和变化。新论文的实验结论不要直接替换成普遍结论;过去的理论与实现不因年份旧就自动无效。

图与实验

knowledge/public/images/atlas-overview.png 由内置 image-gen 生成,作为概念总览。提示词与生成方式保存在仓库的 docs/assets.md。它不承载精确数值。

十张结构示意和数值图由两个脚本生成;需 Python、NumPy 与 Matplotlib:

python scripts/generate-figures.py
python scripts/generate-research-figures.py
python examples/numerical_checks.py
npm run research:check

基础与预训练的数值脚本依赖 NumPy,CPU 小 Transformer 训练依赖 PyTorch,其他数值脚本使用 Python 标准库;完整列表见 研究实验集。图表均为教学算例,不是硬件或模型实测。公式使用 MathJax 在构建时渲染为 SVG;主题提供横向滚动容纳窄屏长公式。

下载代码使用 HTML <a href="./example.py" download>下载示例</a>;构建会把 knowledge/ 下的 Python 文件按原相对路径复制到产物,保证网页下载与仓库源文件一致。不要把可运行代码只放在已忽略的构建目录中。

检查分层

docs:check 核对结构、本地链接和存档哈希;docs:build 验证实际 Markdown/Vue 构建;docs:check-built 检查构建 HTML 的本地页面、资源引用及数学渲染错误标记。浏览器检查负责搜索、主题、目录与窄屏交互。任何一项都不能单独证明全部知识正确,因此重要数学还需要手算或独立审阅。

旧笔记位于 archive/2026-10-15-legacy/,迁移前的 61 个文件有 SHA-256 清单。存档保留当时工作区状态,不参与当前站点搜索。