Skip to content

About

ZCode skill: deep-read a book into an Obsidian-ready markdown note (MIT)

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

1 Commit

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

deep-book-notes

A ZCode / agent skill that deep-reads a book and writes one Obsidian-ready Markdown note.

通读本地书籍(EPUB / PDF / TXT)→ 按论证画章节地图 → 检索公开评价 → 写独立思考 → 生成可在 Obsidian 打开的 .md。

License: MIT.

This repository is a reusable workflow. It does not include any copyrighted book text.

What it does

When you ask an agent to “仔细阅读这本书并写成 Obsidian 笔记”, the skill tells the model to:

  1. Extract the real text with scripts/extract_book.py (EPUB-as-zip, heading-aware, chapter files).
  2. Read in batches instead of stuffing 500k characters into one prompt.
  3. Map the book as a few argument arcs, not a table-of-contents dump.
  4. Add public reception (Douban / Goodreads / Wikipedia / author site) including criticism.
  5. Write a thinking section that is not a restatement of the summary.
  6. Emit a single UTF-8 note with YAML, callouts, wikilinks, and an “open in Obsidian” path.

Install

Copy or clone this folder to a skill-discovery path:

~/.agents/skills/deep-book-notes/SKILL.md

or, for a single project:

<project>/.agents/skills/deep-book-notes/SKILL.md

ZCode also looks at ~/.zcode/skills/ and <project>/.zcode/skills/ (those win if the same name exists).

git clone https://github.com/galagersharp-code/deep-book-notes.git ~/.agents/skills/deep-book-notes

On Windows (Git Bash):

git clone https://github.com/galagersharp-code/deep-book-notes.git "$HOME/.agents/skills/deep-book-notes"

Restart the agent session so it rediscovers skills.

Use

You do not have to type the skill name. Natural requests should trigger it:

  • 用尽办法仔细阅读这本书,结合网上评价写思考,生成 md 给我用 Obsidian 打开
  • 通读这个 EPUB,写一份阅读笔记
  • Read this book and make an Obsidian note with reviews and my own take

Point the agent at a local file. Example:

/deep-book-notes 仔细阅读 D:\books\example.epub,写成 Obsidian 笔记

Extractor (optional, the agent should run this itself):

python scripts/extract_book.py "/path/to/book.epub" --out-dir "_book_extract/example"

Requires Python 3.9+. EPUB / HTML / TXT use the standard library. PDF needs pypdf or pymupdf.

Output

One Markdown file, typically:

《短标题》_阅读笔记.md

Structure is in assets/note-template.md: YAML frontmatter, abstract callout, argument map, chapter notes, reviews, hindsight, independent thinking, quotes, Obsidian open path, copyright line.

What this is not

  • Not a book piracy tool. Do not commit EPUBs or full_text.txt to git.
  • Not a substitute for the book. The note is a guide.
  • Not a generic “summarize this PDF” prompt. The point is coverage + judgment.

Layout

deep-book-notes/
├── SKILL.md                 # agent instructions
├── LICENSE                  # MIT
├── README.md
├── assets/note-template.md  # Obsidian note skeleton
└── scripts/extract_book.py  # local extractor

Try these prompts

  1. 仔细阅读 <path-to.epub>,把握主要内容,结合互联网评价写思考,生成 md 用 Obsidian 打开
  2. 继续 — after a long book, the skill should resume from _book_extract/ rather than re-extract.
  3. Read <path-to.pdf> and write an Obsidian note; I care more about what aged badly than a chapter list

Contributing

Issues and PRs welcome. Keep SKILL.md under ~500 lines; put extra domain notes in references/ if needed. Do not add copyrighted books or large extracts to the repo.

About

ZCode skill: deep-read a book into an Obsidian-ready markdown note (MIT)

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages