Skip to content

Charliechen114514/grimoire

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Grimoire

中文 | English


AI 时代了还要啃教材?把 PDF 丢进来,让它用 你喜欢的风格 帮你重写成带练习题的教程网站。

快速上手指南 →

One-liner:

配置好config/writing_style.md后即可运行下面的指令开始尝试。

# PDF 教材(请替换成自己的pdf,非扫描稿)
python -m cli all books/textbook.pdf --slug MYBOOK

# Wolai 教程网站
python cli.py all "https://www.wolai.com/fkGSwxLu2pjWD7kiBY1V7W" --slug RTR4 --workers 4

Grimoire 解析技术 PDF 教材或 Web 教程网站,通过 AI 提取每章核心概念,以可配置的写作人格(config/writing_style.md)生成教程正文,创建分级练习题,提炼要点,最终打包为可部署的 MkDocs 静态网站。

支持多种数据源:PDFWolai(公开 API 秒级解析)、静态 HTML 网站Playwright SPA 渲染,也可通过自定义引擎插件扩展。支持 --verbose-mode 进行忠于原文的分节详细改写,大章节自动分节防截断,--workers N 并行加速处理。

文档

文档 说明
架构设计 Pipeline 流程、Agent 说明、项目结构、自定义配置、已知限制
使用指南 安装步骤、CLI 命令、各阶段用法、依赖要求

许可证

MIT License


Still dozing off reading PDF textbooks? Toss it in — Grimoire rewrites it into a tutorial website in your preferred style, complete with exercises.

Quick Start Guide →

One-liner:

# PDF textbook
python -m cli all books/textbook.pdf --slug MYBOOK

# Wolai tutorial site (auto-detected engine, instant parsing)
python cli.py all "https://www.wolai.com/fkGSwxLu2pjWD7kiBY1V7W" --slug RTR4 --workers 4

Grimoire parses technical PDF textbooks and web tutorial sites, extracts core concepts via AI, generates tutorial content in a configurable persona (config/writing_style.md), creates leveled exercises, and packages everything into a deployable MkDocs static site.

Multiple data sources supported: PDF, Wolai (public API, instant parsing), static HTML sites, Playwright SPA rendering, and custom engine plugins. Supports --verbose-mode for faithful section-by-section rewrites, auto-splitting large chapters to prevent truncation, and --workers N for parallel processing.

Documentation

Document Description
Architecture Pipeline flow, agent descriptions, project structure, customization, limitations
Usage Installation, CLI commands, per-phase usage, dependencies

License

MIT License

About

PDF 教材 → 交互式教程网站。Grimoire 将技术 PDF 解析为章节,利用 AI agents 提取核心概念,生成可自定义风格的教程,创建分级练习,并构建可部署的 MkDocs 站点——所有这些都通过一个 CLI 命令完成。

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors