mirror of
https://github.com/eternity4719/HowToLiveBetter.git
synced 2026-11-20 08:32:18 +08:00
构建命令注释对齐,README 页尾说明和 CLAUDE.md 的 EPUB 命令同步改成 npm --prefix 写法
This commit is contained in:
@@ -98,7 +98,7 @@ README 开头「这本书想回答的问题」表**一节只占一行**(2026-0
|
||||
- **超长的收益、备注和来源在四个出口里都拆成子条目,正文 md 不动**:收益、备注超过 300 字的,在句号处、且下一句开始引用新依据(「X看《…》」「《某条例》」「刑法第…条」「另一项试验」「案例二」等)时断开;来源按括号外的「;」一条一行。规则有两份,`tools/lib/split-items.mjs` 给 EPUB、PDF,index.html 里 `// <split-rules>` 那段给检索网页和离线版,**改一边要同步改另一边**,`node tools/check-split.mjs` 拿全书逐条比对两边结果,也查拆完能不能逐字拼回原文、`**` 有没有被拆开(CI 里是「拆分规则一致性检查」job)。正文仍一个字段一行,index.html 按行解析、sync-stats 按「- 来源:」行数链接都不受影响。
|
||||
- **生活自查页 `selfcheck.html`**(2026-10-11 加,入口在 index.html 页头、README 导航表格「自查」行、sitemap):一组是否题,每题按「第几节 + 标题里的一段字」对到一条条目,不写条号,结果页按做到比例、性价比和成本标签里的毅力分堆汇总。**故意不算「少活几年」**:各条的风险来自不同研究、互相重叠,不能相乘。改条目标题时,如果删掉了某题用的那段字,这题会静默消失,控制台报错;改完标题用 `grep -o "key:'[^']*'" selfcheck.html` 对一遍。离线单文件版不带它,build.mjs 把链接改写成线上地址。
|
||||
- **最近更新 `updates.json`**(2026-10-15 加,读者不知道最近改了什么、只能从头看):`tools/updates.mjs` 翻 main 的第一父提交,按标题逐条比对 book/,记下每条哪天新增、正文哪天实质改过,检索页据此在页头报「最近 7 天新增 N 条、改过 M 条」,侧栏有「最近更新」筛选,卡片上标日期。不看提交信息。光改措辞不算「改过」:要标题或证据等级变了、某栏数字变了、或某栏加长不少才算;来源栏、成本标签、条号和锚点的变动都不算。起算日 2026-10-01,之前的条目不标。sync-stats 会自动跑它,工作区里没提交的改动记成当天;CI 的「统计数字检查」job 用 `--check` 比对,只比条目和栏目、不比日期,所以 checkout 要 `fetch-depth: 0`。离线单文件版把它内联进 `__CORPUS__.updates`。
|
||||
- EPUB:`tools/epub/build.mjs`(只依赖 marked,zip 用 `tools/lib/zip.mjs` 自己打,Anki 牌组也用它),CI 里跑 epubcheck。本地 `cd tools/epub && npm ci && npm run build`。
|
||||
- EPUB:`tools/epub/build.mjs`(只依赖 marked,zip 用 `tools/lib/zip.mjs` 自己打,Anki 牌组也用它),CI 里跑 epubcheck。本地在仓库根目录跑 `npm --prefix tools/epub ci && npm --prefix tools/epub run build`(别 `cd` 进去,后面接着跑别的构建会找不到路径,PR #138)。
|
||||
- 离线单文件 HTML:`tools/offline/build.mjs`(零依赖)把正文**和 docs 长文**内联进 index.html 的 `window.__CORPUS__`(`parts` 放 book/、`docs` 放长文),双击就能看、离线可用;index.html 的 `init()` 认这个变量就不发请求,改 init 的取数逻辑要同时顾到这条路。**检索页的长文是就地弹窗打开的,不跳 GitHub**:点击处统一拦「指向 `docs/*.md` 的 GitHub 链接」(页头那行长文、条目备注里 `hrefOf()` 转出来的相对链接,形状都是这一个),弹窗自带一份可点的章节目录和 scrollspy,markdown 由 index.html 里那个只认标题/段落/列表/表格的小渲染器处理,不引库。长文里如果开始用引用块、代码块这类新语法,要同步加进那个渲染器。
|
||||
- PDF:`tools/pdf/build.mjs` + `tools/pdf/template.typ`,pandoc 转 typst、typst 排版(A4、每节另起一页、页眉带节名、目录带页码、书签到条目级)。本地要 pandoc ≥ 3.1 和 typst ≥ 0.13,用环境变量 `PANDOC`、`TYPST` 指到可执行文件;CI 里按 workflow 顶部 env 里钉的版本下载。版面只改 template.typ。
|
||||
- Anki 牌组:`tools/anki/build.mjs`(零依赖,用 Node 自带的 `node:sqlite`,要 Node ≥ 22.13),issue #97 加的。一条一张问答卡,按节分子牌组,正面节名加标题,背面说人话、成本、性价比、收益量级、口径、证据等级和在线版链接;标签带节号、证据等级、性价比档、口径、争议。性价比规则和 sync-stats 共用 `tools/lib/book.mjs` 的 `COST_W`、`ratioOf`。**笔记 guid 是「hltb-节号-条号」**,牌组和笔记类型的 id 写死,所以重新导入时 Anki 更新内容、保留复习记录;删条目让条号整体减一时,老用户的复习记录会错位一条,这是已知代价。完形填空要逐条人工标,没做。验证办法:scratchpad 里建 venv 装官方 `anki` 包(`pip install --only-binary :all: anki`,不加这个参数会卡在源码构建),用 `import_anki_package` 导入两次,看第二次是否全部算「更新」。
|
||||
|
||||
@@ -157,8 +157,8 @@ python -m http.server 8000
|
||||
想自己生成这四样(平时用不着,Release 里的就是自动生成的)。下面的命令都在仓库根目录(`HowToLiveBetter/`)运行:
|
||||
|
||||
```bash
|
||||
npm --prefix tools/epub ci # 安装 EPUB 依赖
|
||||
npm --prefix tools/epub run build # EPUB
|
||||
npm --prefix tools/epub ci # 安装 EPUB 依赖
|
||||
npm --prefix tools/epub run build # EPUB
|
||||
node tools/offline/build.mjs # 离线单文件 HTML
|
||||
node tools/pdf/build.mjs # PDF,另需 pandoc ≥ 3.1 和 typst ≥ 0.13
|
||||
node tools/anki/build.mjs # Anki 牌组,要 Node ≥ 22.13(用自带的 node:sqlite)
|
||||
@@ -309,7 +309,7 @@ A 级只说明「有具体数字、出处可核」,不说明这个数字一定
|
||||
|
||||
本书在 Claude Code 协助下编写:查找原始文献、逐条核对数字与原文是否一致、维护交叉引用和构建脚本。选题、取舍和最终审定由作者负责,每条数字都能在来源栏的原文里找到。
|
||||
|
||||
仓库根目录的 `index.html` 是在线检索页:按关键词、章节、证据等级和成本维度(花钱、花时间、要毅力)筛选条目,数据直接读本文件。在仓库设置里开启 GitHub Pages(Deploy from a branch,分支 main,目录 /)后即可访问。`tools/epub/` 是电子书生成脚本,`cd tools/epub && npm ci && npm run build` 在本地出一本 EPUB 到 `dist/`;GitHub Actions 在正文改动后自动跑同一个脚本并更新 Release。
|
||||
仓库根目录的 `index.html` 是在线检索页:按关键词、章节、证据等级和成本维度(花钱、花时间、要毅力)筛选条目,数据直接读本文件。在仓库设置里开启 GitHub Pages(Deploy from a branch,分支 main,目录 /)后即可访问。`tools/epub/` 是电子书生成脚本,在仓库根目录跑 `npm --prefix tools/epub ci && npm --prefix tools/epub run build` 在本地出一本 EPUB 到 `dist/`;GitHub Actions 在正文改动后自动跑同一个脚本并更新 Release。
|
||||
|
||||
## 正文
|
||||
|
||||
|
||||
Reference in New Issue
Block a user