book-metrics-generator

Generate book and chapter metrics reports for MkDocs Material textbooks.

90|12|Updated Nov 1, 2025
One-click install
npx skills add https://github.com/dmccreary/claude-skills --skill book-metrics-generator
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: book-metrics-generator
Source: https://github.com/dmccreary/claude-skills/tree/main/skills/book-metrics-generator
Command: npx skills add https://github.com/dmccreary/claude-skills --skill book-metrics-generator

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires python3, and includes scripts (resource) components.

What problem does it solve?

This Skill automates the generation of comprehensive metrics reports for intelligent textbooks built with MkDocs Material, analyzing chapters, concepts, glossary terms, FAQs, quiz questions, diagrams, equations, MicroSims, word counts, and links. It helps authors track progress, assess content balance, and prepare status reports.

Core Features & Use Cases

  • Book-level statistics: Overall statistics for the entire textbook.
  • Chapter-level metrics: Per-chapter breakdowns for granular insights.
  • Output & integration: Writes metrics files to docs/learning-graph and can be integrated into MkDocs navigation.

Quick Start

To install this skill and run its shell script, use the provided CLI: ~/ .claude/skills/book-metrics-generator/scripts/book-metrics-generator.sh After running, review:

  • docs/learning-graph/book-metrics.md
  • docs/learning-graph/chapter-metrics.md Then update mkdocs.yml navigation accordingly.

Frequently Asked Questions about book-metrics-generator

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate metrics reports for my MkDocs Material textbook?

Generate metrics reports by running the book-metrics-generator shell script on your MkDocs Material docs directory. It analyzes chapters, concepts, glossary terms, FAQs, quiz questions, diagrams, equations, MicroSims, and word counts, producing book-metrics.md and chapter-metrics.md files in docs/learning-graph.

What does the book-metrics-generator analyze in my textbook?

Book-metrics-generator analyzes chapters, concepts, glossary terms, FAQs, quiz questions, diagrams, equations, MicroSims, word counts, and links across your entire MkDocs Material textbook, delivering both overall book statistics and per-chapter breakdowns.

Can I automate textbook content analysis with MkDocs Material?

Yes. This skill automates comprehensive content analysis for MkDocs Material textbooks, tracking progress and assessing content balance by generating detailed metrics across all structural and pedagogical components without manual counting.

What directory structure does book-metrics-generator require?

Book-metrics-generator requires a standard MkDocs layout with docs, docs/chapters, and docs/learning-graph directories. It reads from these locations and outputs metrics files to docs/learning-graph for integration into your mkdocs.yml navigation.

Do I need Python to run book-metrics-generator?

Yes. Book-metrics-generator requires Python 3 as its primary dependency. The skill runs via a shell script that executes the Python program to generate your textbook metrics.

How do I integrate generated metrics into my MkDocs navigation?

After running book-metrics-generator, review the output files book-metrics.md and chapter-metrics.md in docs/learning-graph, then update your mkdocs.yml navigation configuration to include these metrics reports in your site structure.