Yao Weread Skill logo

Yao Weread Skill

CommunityPopular
yaojingang
yao-weread-skill

当用户需要分析微信读书阅读历史、生成读书报告、可视化阅读统计、笔记、书架、词云、热力图、雷达图,或导出精排 HTML 报告时使用。也适用于创建 AI 创业者示例阅读报告。不用于通用图书推荐,或不生成报告的原始微信读书 API 查询。

Overview

Publisheryaojingang
Repositoryyao-open-skills
Skill nameyao-weread-skill
Stars
1.3K
Forks
149
Bundled files
10
LicenseMIT
Links
  • Markdown instructions

    A SKILL.md file the model loads on demand, so it only costs tokens when a request actually matches.

  • Works with any LLM

    AI skills are plain Markdown, not provider-specific code, so this works with GPT, Claude, Gemini, Grok, or a local model.

  • 10 bundled files

    Scripts, templates, and references the model can read while it works. Files are read-only and never executed.

  • Open source

    Published by yaojingang on GitHub. Read the source before you install it.

Installation

Install the Yao Weread Skill AI skill in TypingMind to use it with any LLM, or drop it into another agent that reads SKILL.md.

1

Install in TypingMind

TypingMind installs a skill straight from its GitHub folder — it reads SKILL.md, bundles the resource files, and stores the result locally.

  1. Open the app and go to Plugins → Skills.
  2. Choose "Install from GitHub".
  3. Paste the skill folder URL below and confirm.
  4. Enable the skill in any chat where you want it available.
Plugins → Skills → Add skill → From GitHub URL, then paste the folder URL and press Continue.
2

Install in another agent

Any agent that reads the Agent Skills format can use this skill — copy the folder into that agent's skills directory.

Claude Code — .claude/skills
git clone --depth 1 https://github.com/yaojingang/yao-open-skills.git /tmp/yao-open-skills
mkdir -p .claude/skills
cp -r /tmp/yao-open-skills/skills/yao-weread-skill .claude/skills/yao-weread-skill
Restart Claude Code after copying so it picks up the new skill.

Use it in TypingMind

Enable Yao Weread Skill in any TypingMind chat and the model takes it from there. Its name and description sit in the system prompt, and the moment a request matches, the model loads the full instructions itself — you never invoke it by hand, and it costs no tokens until it is actually used.

The model loads Yao Weread Skill on its own as soon as a request matches it.

Works with any AI model

AI skills are plain Markdown instructions rather than provider-specific code, so Yao Weread Skill is not tied to the model it was written for. Install it once in TypingMind and use it with GPT-5, Claude, Gemini, Grok, DeepSeek, Mistral, Llama, or a local model you run yourself — all on your own API keys.

  • Loaded only when it is needed

    The system prompt carries just the name and description. The instructions are fetched on the first matching request, so an idle skill costs nothing.

  • Switch models mid-chat

    Because the skill is instructions rather than code, changing model does not break it — the next model reads the same SKILL.md.

Skill instructions

This is the SKILL.md content the model loads. Read it before installing — a skill is instructions your model will follow.

Yao WeRead Skill

从微信读书账号数据生成精排中文 HTML 报告。默认范围为截至今天的最近 24 个月。

输入

  • 环境变量 WEREAD_API_KEY,格式遵循微信读书 skill 的要求。
  • 可选报告范围:--years--start--end
  • 可选笔记深度:--max-note-books;省略或传 0 时处理微信读书返回的全部笔记书籍。
  • 可选输出目录。
  • 可选示例模式:--sample-ai-founder --sample-scale 5,不需要 WEREAD_API_KEY

输出

流程会生成:

  • weread-report.html:参考 kami 排版风格的交互式 HTML 报告。
  • weread-report-data.json:聚合后的图表数据。
  • weread-raw-summary.json:不含密钥的 API 结构和计数摘要,便于复核。

报告还会生成一个读者画像模块:顶部诗性总结、1 条画像金句,以及从近两年划线中筛选出的最多 20 条高价值句子。原始划线和想法仅用于聚合分析与画像筛选。除非用户明确要求分享或发布,否则报告产物应视为私有内容。

工作流

  1. 调用 API 前先阅读微信读书 skill 文档:
    • shelf.md:书架计数、公开/私密规则。
    • readdata.md:阅读时长单位、周期规则、年度/月度字段。
    • notes.md:笔记分页、笔记数计算、划线/想法文本。
    • book.md:仅在需要书籍详情或阅读进度时使用。
  2. 运行 scripts/generate_weread_report.py
  3. 检查生成的 HTML 至少包含 20 个图表面板,没有 TODO、占位文本或内嵌 API key。
  4. 检查矩形树图、热力图、横向条形图等高密度图表没有被默认边距压缩,没有右侧空白导致标签截断。
  5. 检查读者画像模块:金句必须来自画像划线清单第一条;真实账号模式不得编造划线,划线不足 20 条时如实少展示。
  6. 如果用户要求视觉验证,或报告排版有实质变化,使用浏览器打开生成的 HTML,并检查桌面、平板宽度和窄屏宽度。

命令

bash
python3 scripts/generate_weread_report.py --output reports/generated

常用选项:

bash
python3 scripts/generate_weread_report.py \
  --years 2 \
  --max-note-books 0 \
  --output reports/generated

AI 创业者示例报告:

bash
python3 scripts/generate_weread_report.py \
  --years 2 \
  --sample-ai-founder \
  --sample-scale 5 \
  --output reports/generated/ai-founder-sample

报告设计

  • 视觉系统遵循 references/report-design.md
  • 图表模块遵循 references/chart-catalog.md
  • API 字段语义和降级规则遵循 references/data-contract.md
  • 高密度图表必须显式设置容器占满、标签换行/隐藏策略和 resize 监听,避免 ECharts 默认布局留下空白。
  • 内容画像必须基于真实划线文本生成,顶部总结可以使用统计口径生成温暖、诗性但不冒充用户原文的描述。

边界

  • 真实账号模式下,不编造微信读书响应中不存在的阅读事件、笔记文本、评分或分类。
  • AI 创业者示例模式用于在不接入真实账号时生成可复用示例报告。
  • 不导出书籍全文;只使用用户自己的划线/想法,以及微信读书 skill 可访问的元数据。
  • 不存储或打印 WEREAD_API_KEY
  • 无法获得精确滚动日期边界时,必须清楚标注月度或年度近似口径。

Bundled files

The model reads these on demand while the skill is loaded. They are exposed as readable files and are never executed.

Frequently asked questions

What does the Yao Weread Skill AI skill do?

当用户需要分析微信读书阅读历史、生成读书报告、可视化阅读统计、笔记、书架、词云、热力图、雷达图,或导出精排 HTML 报告时使用。也适用于创建 AI 创业者示例阅读报告。不用于通用图书推荐,或不生成报告的原始微信读书 API 查询。

Why use Yao Weread Skill on TypingMind?

Because you install it once and use it with any model. Yao Weread Skill is plain Markdown rather than provider-specific code, so the same skill runs on GPT-5, Claude, Gemini, Grok, or a local model — and you can switch model mid-chat without it breaking. TypingMind runs on your own API keys, so you pay providers directly instead of a per-seat subscription, and your skills and chats stay in your own storage.

How do I install Yao Weread Skill in TypingMind?

Open Plugins → Skills → Install from GitHub in TypingMind and paste https://github.com/yaojingang/yao-open-skills/tree/main/skills/yao-weread-skill. TypingMind reads its SKILL.md and bundles its files and installs it as a skill you can enable per chat.

Which AI models can use Yao Weread Skill?

Any model you connect in TypingMind. AI skills are plain Markdown instructions rather than provider-specific code, so GPT, Claude, Gemini, Grok, and local models can all load this skill when a request matches it.

How many AI models can I use with Yao Weread Skill?

As many as you like. As long as a model supports skills, you can use Yao Weread Skill with it — GPT, Claude, Gemini, Grok, DeepSeek, Mistral, Llama and more — all on TypingMind with your own API keys.

Is the Yao Weread Skill AI skill free?

Yes. It is published on GitHub by yaojingang under the MIT license. You only pay your own AI provider for the tokens you use.

What are AI skills?

An AI skill is a reusable instruction bundle that teaches an AI model how to do one specific task. It follows the open Agent Skills format: a SKILL.md file with a name and description, plus any scripts, templates or reference files the model may need. The model reads the instructions only when your request matches the skill, so an installed skill costs nothing until it is used.

How are AI skills different from plugins or MCP servers?

A plugin or MCP server gives a model new tools to call — code that runs somewhere and returns a result. An AI skill gives the model knowledge and process instead: how to approach a task, which steps to follow, what good output looks like. Skills are plain Markdown, so they need no server, no API key and no runtime, and they work with any model.

View all

Set up your own AI workspace now

Get notified about new features and future giveaways by subscribing to our newsletter 👇