Skip to content

Commit 47d37f2

Browse files
merge hooks and remove templates file
1 parent a8c3d0e commit 47d37f2

6 files changed

Lines changed: 61 additions & 287 deletions

File tree

.templates/article-template.md

Lines changed: 0 additions & 114 deletions
This file was deleted.

.templates/platform-tutorial-template.md

Lines changed: 0 additions & 65 deletions
This file was deleted.

.templates/reference-card-template.md

Lines changed: 0 additions & 67 deletions
This file was deleted.

.templates/todo-template.md

Lines changed: 0 additions & 35 deletions
This file was deleted.

scripts/cppref_card_generator.py

Lines changed: 60 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,67 @@
4747
PROJECT_ROOT = SCRIPT_DIR.parent
4848
DEFAULT_CACHE_DIR = SCRIPT_DIR / "cppref_cache"
4949
DEFAULT_MANIFEST = SCRIPT_DIR / "cppref_manifest.json"
50-
TEMPLATE_PATH = PROJECT_ROOT / ".templates" / "reference-card-template.md"
50+
TEMPLATE_PATH = None # 模板已内联,见 REFERENCE_CARD_TEMPLATE
5151
WRITING_STYLE_PATH = PROJECT_ROOT / ".claude" / "writting_style.md"
5252

53+
REFERENCE_CARD_TEMPLATE = """\
54+
---
55+
title: "特性名称"
56+
description: "一句话摘要"
57+
chapter: 99
58+
order: 0
59+
tags:
60+
- host
61+
- cpp-modern
62+
- beginner
63+
difficulty: beginner
64+
cpp_standard: [11, 14, 17]
65+
---
66+
67+
# 特性名称(C++XX)
68+
69+
## 一句话
70+
71+
用一句人话说清楚这是什么、解决什么问题。
72+
73+
## 头文件
74+
75+
`#include <...>`
76+
77+
## 核心 API 速查
78+
79+
| 操作 | 签名 | 说明 |
80+
|------|------|------|
81+
| ... | `...` | ... |
82+
83+
## 最小示例
84+
85+
```cpp
86+
// 完整可编译的最小示例,不超过 20 行
87+
// Standard: C++XX
88+
```
89+
90+
## 嵌入式适用性:高/中/低
91+
92+
- 要点 1
93+
- 要点 2
94+
95+
## 编译器支持
96+
97+
| GCC | Clang | MSVC |
98+
|-----|-------|------|
99+
| X.Y | X.Y | 19.X |
100+
101+
## 另见
102+
103+
- [教程:对应章节](相对路径)
104+
- [cppreference: 特性名](https://en.cppreference.com/w/cpp/...)
105+
106+
---
107+
108+
*部分内容参考自 [cppreference.com](https://en.cppreference.com/),采用 [CC-BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/) 许可*
109+
"""
110+
53111
SYSTEM_PROMPT = """\
54112
你是一个 C++ 参考文档生成助手。你的任务是根据 cppreference 的原始内容,生成符合以下模板的中文参考卡。
55113
@@ -237,10 +295,7 @@ def main():
237295
args = parser.parse_args()
238296

239297
# 加载模板
240-
if not TEMPLATE_PATH.exists():
241-
print(f"错误: 模板文件不存在: {TEMPLATE_PATH}", file=sys.stderr)
242-
sys.exit(1)
243-
template = TEMPLATE_PATH.read_text(encoding="utf-8")
298+
template = REFERENCE_CARD_TEMPLATE
244299

245300
# 加载 manifest
246301
with open(args.manifest, "r", encoding="utf-8") as f:

todo/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ estimated_effort: small|medium|large|epic
5959

6060
## 模板
6161

62-
新建 TODO 文件时,使用 `.templates/todo-template.md` 模板
62+
新建 TODO 文件时,参照本目录已有文件的 frontmatter 格式
6363

6464
## 归档
6565

0 commit comments

Comments
 (0)