book-metrics-generator

Generate content metrics for an MkDocs intelligent textbook by running the provided shell script in your terminal. It automatically analyzes chapters, concepts, glossary terms, and quizzes, outputting two markdown files with overall and per-chapter statistics.

You can automatically analyze textbook elements including chapters, concepts, glossary terms, FAQs, quiz questions, diagrams, equations, MicroSims, word counts, and links. This provides quantitative insights into content volume and interactive educational components for status reporting.

Yes, you need Python 3 installed to run the analysis script. Additionally, your project must use an MkDocs Material-based intelligent textbook structure to ensure the script can accurately parse and evaluate the educational content.

The generated textbook content analysis reports are saved as two markdown files: book-metrics.md for overall statistics and chapter-metrics.md for per-chapter breakdowns. These files document quantitative insights into the analyzed content.

You should run automated content analysis on your textbook project after significant content development or when you need project status reporting. It provides quantitative insights into content volume, educational components, and interactive elements.