Skip to content

Commit bcd39ce

Browse files
Merge pull request #4 from FelixWayne0318/claude/review-repo-docs-5yiWO
2 parents 4eadf21 + 4e78b40 commit bcd39ce

33 files changed

Lines changed: 2394 additions & 15 deletions
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
{
2+
"ignorePatterns": [
3+
{
4+
"pattern": "^https://felixwayne0318.github.io/"
5+
},
6+
{
7+
"pattern": "^https://creativecommons.org/"
8+
},
9+
{
10+
"pattern": "^https://anthropic.com"
11+
},
12+
{
13+
"pattern": "^https://claude.ai"
14+
},
15+
{
16+
"pattern": "^https://github.com/anthropics/"
17+
},
18+
{
19+
"pattern": "^https://fonts.googleapis.com/"
20+
}
21+
],
22+
"replacementPatterns": [],
23+
"httpHeaders": [
24+
{
25+
"urls": ["https://github.com/", "https://api.github.com/"],
26+
"headers": {
27+
"Accept": "text/html",
28+
"User-Agent": "Mozilla/5.0"
29+
}
30+
}
31+
],
32+
"timeout": "20s",
33+
"retryOn429": true,
34+
"retryCount": 3,
35+
"fallbackRetryDelay": "30s",
36+
"aliveStatusCodes": [200, 206, 301, 302, 308]
37+
}

.github/workflows/link-check.yml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: Link Check
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
workflow_dispatch:
8+
schedule:
9+
# 每周一早 8 点(UTC)跑一次,捕捉外链失效
10+
- cron: '0 8 * * 1'
11+
12+
jobs:
13+
check-links:
14+
runs-on: ubuntu-latest
15+
steps:
16+
- uses: actions/checkout@v4
17+
18+
- name: Check Markdown links
19+
uses: gaurav-nelson/github-action-markdown-link-check@v1
20+
with:
21+
use-quiet-mode: 'yes'
22+
use-verbose-mode: 'yes'
23+
config-file: '.github/markdown-link-check-config.json'
24+
file-extension: '.md'
25+
folder-path: '.'
26+
base-branch: 'main'

.github/workflows/publish.yml

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: Publish Book
2+
3+
on:
4+
push:
5+
branches: [main]
6+
workflow_dispatch:
7+
8+
permissions:
9+
contents: write
10+
pages: write
11+
id-token: write
12+
13+
jobs:
14+
build-deploy:
15+
runs-on: ubuntu-latest
16+
steps:
17+
- name: Check out repository
18+
uses: actions/checkout@v4
19+
with:
20+
fetch-depth: 0
21+
22+
- name: Set up Quarto
23+
uses: quarto-dev/quarto-actions/setup@v2
24+
with:
25+
version: "1.5.57"
26+
27+
- name: Install Chinese fonts (Noto CJK)
28+
run: |
29+
sudo apt-get update
30+
sudo apt-get install -y fonts-noto-cjk fonts-noto-cjk-extra
31+
32+
- name: Render and Publish to GitHub Pages
33+
uses: quarto-dev/quarto-actions/publish@v2
34+
with:
35+
target: gh-pages
36+
render: true
37+
env:
38+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -205,3 +205,23 @@ cython_debug/
205205
marimo/_static/
206206
marimo/_lsp/
207207
__marimo__/
208+
209+
# Quarto build artifacts
210+
/_book/
211+
/.quarto/
212+
*.tex
213+
!filters/*.tex
214+
site_libs/
215+
216+
# OS / editor cruft
217+
.DS_Store
218+
Thumbs.db
219+
*.swp
220+
*~
221+
222+
# Word/Office temporary files (in case of paste-from-Word workflow)
223+
~$*
224+
*.docx#
225+
226+
# Local writing drafts (per CLAUDE.md convention)
227+
/drafts/

CLAUDE.md

Lines changed: 122 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -78,8 +78,127 @@
7878
- 引用历史事件和科学理论时确保准确性
7979
- 不对原有理论框架做任何修改,除非作者明确要求
8080

81+
## 写作规范细则
82+
83+
### 标点
84+
85+
- 中文部分使用**全角标点**`,。;:!?""''()`
86+
- 英文/数字部分使用**半角标点**`,.;:!?""''()`
87+
- 中英/中数混排时,**中文与拉丁字母数字之间留一个半角空格**
88+
- 正例:使用 Quarto 渲染、约 25,000 字、定律 III
89+
- 反例:使用Quarto渲染、约25,000字
90+
- 破折号:使用全角双破折号 `——`,不用单破折号 ```--`
91+
- 省略号:使用 `……`(六点居中),不用 `...`
92+
- 数字范围用 ``(en-dash):`6,000–8,000 字`
93+
94+
### 数字格式
95+
96+
- 正文中四位数及以下不加千位分隔:`2008 年``五百年``500 年`
97+
- 五位数及以上加千位分隔:`16,000 字``138 亿年`
98+
- 大数字优先用中文计数单位:`1.5 万字` 优于 `15,000 字`(科普书更易读)
99+
- 年份不加千位:`2008 年`,不写成 `2,008 年`
100+
101+
### 引号
102+
103+
- 优先使用全角双引号:`""` 表示"引述、强调、专名"
104+
- 引号内嵌套用全角单引号:`'…'`
105+
- 不使用直引号 `"``'`
106+
107+
### 强调用法
108+
109+
- **粗体**:用于**关键概念、首次定义的术语、定律/前提名**
110+
- *斜体*:用于*书名、引语*(中文斜体被浏览器伪斜显示,慎用)
111+
- ***粗斜体***:用于***特别强调***(每节最多 1-2 处)
112+
- 引号:用于"引述、专有名词、有保留态度的措辞"
113+
114+
### 段落
115+
116+
- 段落首行缩进交给 CSS(`theme.scss`),**不要在 Markdown 里手写空格**
117+
- 每段不超过 5-6 行(屏幕显示约 200 字),过长则分段
118+
- 单行短句强调,前后加空行:
119+
120+
> *像这样的格言句*
121+
122+
### 引用与脚注
123+
124+
- **学术引用**(来源、数据、观点归属)→ 用 BibTeX 引用 `[@key]`
125+
- 例:泰恩特在《复杂社会的崩溃》中将此称为"复杂性的递减收益"[@tainter1988]
126+
- **叙事性补充说明**(专名解释、背景知识)→ 用 Markdown 脚注 `[^name]`
127+
- **不要混用**:脚注里塞引用、引用里写背景,都会让读者来回跳跃
128+
129+
### 图表/定律/定理标号
130+
131+
- 引用图:`@fig-life-cycle`(Quarto 自动生成"图 N"标号)
132+
- 引用表:`@tbl-collapse-mechanisms`
133+
- 引用定律:`@law-1` / `@law-2` / ...
134+
- 引用定理:`@thm-time-arrow` / `@thm-path-dependence` / ...
135+
136+
加标签格式(举例):
137+
138+
```markdown
139+
::: {#thm-time-arrow}
140+
**时间之箭定理**:演化型系统的状态空间单向展开……
141+
:::
142+
143+
后面引用:详见 @thm-time-arrow
144+
```
145+
146+
### 跨章节引用
147+
148+
- 同部跨章用相对路径:`[第二章:生命](./02_生命.md)`
149+
- 跨部用相对路径:`[第三部分:哲学篇](../第三部分_哲学篇.md)`
150+
- 章末导航见现有章节末尾的"上一章/下一章"格式
151+
152+
### 术语使用
153+
154+
- **所有术语必须先在 [`术语表.md`](./术语表.md) 登记**,再进入正文
155+
- 不确定某词是否已用过 → grep 一遍:
156+
157+
```bash
158+
grep -rn "查找词" --include="*.md" .
159+
```
160+
161+
- 不使用 `术语表.md` 标注为 ❌ 的禁用别名
162+
81163
## 命令与工作流
82164

83-
- 写作新章节时,先在对应路径创建 `.md` 文件
84-
- 每完成一个章节或重大修改后提交 git commit
85-
- commit message 使用中文,简要说明修改内容
165+
### 写作前
166+
167+
- 打开 `术语表.md` + `全书提纲.md` + 当前章节,三者并列对照
168+
- `python3 scripts/wordcount.py` 查看字数进度
169+
170+
### 写作中
171+
172+
- 引入新术语 → 立即填入 `术语表.md`
173+
- 引入新引用 → 添加到 `references.bib`,正文用 `[@key]`
174+
- 引入新案例 → 登记到 `术语表.md` H 节"案例归属"
175+
176+
### 写作后
177+
178+
- 检查中英/中数混排的空格
179+
- 跑一遍 `wordcount.py` 看是否在预算内
180+
- 章节定稿前用 grep 扫禁用别名
181+
- 提交 git commit(中文 message,简要说明修改)
182+
- 重大版本更新对应章节的 `docs/CHANGELOG-{章}.md`
183+
184+
### 评估
185+
186+
- **单文档评估**(仅引言):用 [`评估提示词.md`](./评估提示词.md)
187+
- **里程碑评估**(多文档 + 基础设施):用 [`全面评估提示词.md`](./全面评估提示词.md)
188+
- 评估完成后,按 🔴 / 🟡 / 🟢 优先级修订
189+
- 修订完在 commit message 中关联回评估问题编号
190+
191+
### 配套基础设施清单
192+
193+
| 文件 | 作用 |
194+
|:---|:---|
195+
| [`术语表.md`](./术语表.md) | 单一真相源:所有术语 / 定理 / 关键概念 / 案例归属 |
196+
| [`全书提纲.md`](./全书提纲.md) | 章节责任分配 + 主讲/复演归属表 |
197+
| [`字数预算.md`](./字数预算.md) | 各章字数目标 |
198+
| [`references.bib`](./references.bib) | BibTeX 参考文献库 |
199+
| [`scripts/wordcount.py`](./scripts/wordcount.py) | 字数追踪脚本 |
200+
| [`docs/CHANGELOG-*.md`](./docs/) | 各章修订历史 |
201+
| [`_quarto.yml`](./_quarto.yml) | Quarto 项目配置 |
202+
| [`theme.scss`](./theme.scss) | 中文排版主题 |
203+
| [`filters/github-alerts.lua`](./filters/github-alerts.lua) | GitHub Alerts → Quarto Callout 过滤器 |
204+
| [`.github/workflows/`](./.github/workflows/) | CI:自动出版 + 链接检查 |

LICENSE

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
《随机演化论》
2+
Random Evolution
3+
4+
Copyright © 2026 魏永江. All rights reserved.
5+
6+
================================================================================
7+
8+
本作品采用 知识共享 署名-非商业性使用-禁止演绎 4.0 国际许可协议
9+
(Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International,
10+
CC BY-NC-ND 4.0) 进行许可。
11+
12+
完整许可条款(中文):
13+
https://creativecommons.org/licenses/by-nc-nd/4.0/deed.zh-Hans
14+
15+
完整许可条款(英文 / 法律文本):
16+
https://creativecommons.org/licenses/by-nc-nd/4.0/legalcode
17+
18+
================================================================================
19+
20+
简要权利说明
21+
--------------------------------------------------------------------------------
22+
23+
您可以自由地:
24+
25+
* 共享 — 在任何媒介以任何形式复制、发行本作品
26+
27+
但必须遵守以下条件:
28+
29+
* 署名 (BY)
30+
您必须给出适当的署名,提供指向本许可的链接,同时标明是否对原始
31+
作品作了修改。您可以用任何合理的方式来署名,但是不得以任何方式
32+
暗示许可人为您或您的使用背书。
33+
34+
* 非商业性使用 (NC)
35+
您不得将本作品用于商业目的。
36+
37+
* 禁止演绎 (ND)
38+
如果您再混合、转换、或者基于本作品进行创作,您不可以分发修改
39+
作品的整体或部分。
40+
41+
* 没有附加限制
42+
您不得适用法律术语或者技术措施从而限制其他人做许可协议允许的事情。
43+
44+
================================================================================
45+
46+
商业授权与衍生授权
47+
--------------------------------------------------------------------------------
48+
49+
如需用于商业目的(包括但不限于:出版发行、收费课程、商业培训、商品周边
50+
等),或希望基于本作品创作衍生作品(包括翻译、改编、节选汇编等),请
51+
联系作者获取单独授权:
52+
53+
作者:魏永江
54+
联系方式:(待补充)
55+
56+
================================================================================
57+
58+
代码与配置文件
59+
--------------------------------------------------------------------------------
60+
61+
本仓库中的非正文文件(如 `_quarto.yml`、`filters/*.lua`、`theme.scss`、
62+
`.github/workflows/*.yml` 等构建配置与脚本)单独以 MIT 许可协议发布,
63+
可自由复用于其他 Quarto 项目。

0 commit comments

Comments
 (0)