SuperAPI AI 工具集

book-metrics-generator

写作与研究

查看项目

更新于 10-15 21:10

技能介绍

用途:该技能为基于 MkDocs Material 的智能教科书自动生成量化指标,产出两份 Markdown 报告:book-metrics.md(全书统计,含相关章节链接)与 chapter-metrics.md(逐章表格),帮助作者追踪进度、识别内容不足的章节、估算篇幅并做发布前审计。

主要能力:全书指标包括章节数、概念数(来自 learning-graph.csv)、词汇条目(glossary.md 的 H2/H3)、FAQ 数、测验题总数、图表数(以“#### Diagram:”开头的 H4)、LaTeX 公式、MicroSim 数、总词数、链接数及折算页数。折算公式为 Pages = (Total Words ÷ 250) + (Diagrams × 0.25) + (MicroSims × 0.5)。分章指标包含章号、标题、小节数、图表数与词数。

使用方式:项目需有 docs/ 目录、docs/chapters/ 及每章 index.md,learning-graph 目录缺失会自动创建;概念、词汇、FAQ、测验、MicroSim 等为可选项。在项目根目录执行 ./scripts/book-metrics-generator.sh,或指定目录 ./scripts/book-metrics-generator.sh path/to/custom/docs;也可直接运行 python3 scripts/book-metrics.py docs。生成后需在 mkdocs.yml 导航中加入两份报告。脚本可嵌入 CI,在 docs 变更时自动生成并提交指标。

限制:仅面向遵循 intelligent-textbook 结构的 MkDocs Material 教科书;词数统计会排除代码块、行内代码与 URL,可能出现偏差;某些指标(如词汇、FAQ、测验)在文件缺失时计为 0;更多扩展方式与故障排查详见原文档,其余信息暂未提供。