Intelligent Textbook Feature Checklist¶
This checklist helps authors and product managers understand what features are available in the MkDocs Material intelligent textbook ecosystem. For each feature, you'll see whether it's implemented in this book and how much effort it takes to add.
Note
A level 2+ textbook is one that has rich interactivity but does not store any personal student data. A level 2+ textbook can be converted to a level 3 textbook by sending event data to a learning record store (LRS) to create a hyper-personalized learning experience for each student. The five levels of intelligent textbooks are described in the Intelligent Textbooks course.
An intelligent textbook goes beyond static text to include interactive simulations, personalized learning paths, auto-graded quizzes, and AI-generated content. This checklist tracks which of these capabilities are present in this textbook.
Legend:
Feature is implemented and working
Feature is not yet implemented
Feature is partially implemented
Effort Levels¶
| Level | Description | Human Time | With GenAI | With GenAI Skills |
|---|---|---|---|---|
| Trivial | Config change or copy template | Minutes | Seconds | Seconds |
| Low | Single file creation with standard content | Hours | Minutes | Seconds |
| Medium | Multiple files, some customization needed | Day | Hours | Minutes |
| High | Significant content generation or custom code | Days | Hours | Minutes |
| Very High | Complex integration, AI generation, or external tools | Week+ | Day | Hours |
Basic Features¶
These features come by default with MkDocs Material or require minimal configuration.
| Feature | Status | Effort | Notes |
|---|---|---|---|
| Navigation sidebar | | Trivial | Left-side menu showing all chapters and sections |
| Search functionality | | Trivial | Instant search across all pages as you type |
| Table of contents (per page) | | Trivial | Right-side outline of headings on current page |
| Site title and description | | Trivial | "Machine Learning - Algorithms and Applications" |
| Site author metadata | | Trivial | Anvith Pothula |
| GitHub repository link | | Trivial | repo_url configured |
| Custom logo | | Trivial | Cover image used as header logo |
| Custom favicon | | Trivial | Cover image used as favicon |
| Color theme (primary/accent) | | Trivial | Indigo/blue with light/dark toggle |
| Footer navigation (prev/next) | | Trivial | navigation.footer enabled |
| Navigation expand on hover | | Trivial | navigation.expand enabled |
| Back to top button | | Trivial | navigation.top enabled |
| Navigation path breadcrumbs | | Trivial | navigation.path enabled |
| Section index pages | | Trivial | navigation.indexes enabled |
| License page | | Low | CC BY-NC-SA 4.0 license page |
| Contact page | | Low | Author info and contribution guidelines |
| About page (detailed) | | Low | Overview, tech stack, and target audience |
| How We Built This Site | | Medium | Describe tools and process |
| Copyright on every footer | | Trivial | CC BY-NC-SA 4.0 in footer |
Intermediate Features¶
These features require plugins, extensions, or moderate configuration.
Content Enhancement¶
These features make your content more engaging and easier to read.
| Feature | Status | Effort | Notes |
|---|---|---|---|
| GLightBox (image zoom) | | Low | mkdocs-glightbox plugin installed and configured |
| KaTeX equation rendering | | Low | Not configured; currently using MathJax |
| MathJax equation rendering | | Low | pymdownx.arithmatex + MathJax 3 CDN configured |
| Admonitions (callout boxes) | | Trivial | admonition extension enabled |
| Code blocks with copy button | | Trivial | content.code.copy enabled |
| Syntax highlighting with line numbers | | Trivial | pymdownx.highlight with anchor line numbers |
| Tabbed content blocks | | Trivial | pymdownx.tabbed with alternate style |
| Task list checkboxes | | Trivial | pymdownx.tasklist with custom checkboxes |
| Mark/highlight text | | Trivial | pymdownx.mark enabled |
| Strikethrough text | | Trivial | pymdownx.tilde enabled |
| Magic links (auto-linking) | | Trivial | pymdownx.magiclink enabled |
| Snippets (file includes) | | Trivial | pymdownx.snippets enabled |
| Emoji support | | Trivial | pymdownx.emoji with twemoji |
| Collapsible details blocks | | Trivial | pymdownx.details enabled |
| Mermaid diagrams | | Trivial | Custom fence in pymdownx.superfences |
Site-Wide Resources¶
These are pages and files that support the entire textbook rather than individual chapters.
| Feature | Status | Effort | Notes |
|---|---|---|---|
| Glossary | | Medium | 199 terms with ISO 11179 compliant definitions |
| FAQ page | | Medium | 86 answers to common student questions |
| References page | | Medium | Curated bibliography with links per chapter or site-wide |
| Custom CSS styling | | Low | stylesheets/extra.css configured |
| Custom JavaScript | | Low | MathJax CDN configured in extra_javascript |
| Google Analytics | | Trivial | Configured but using placeholder ID (G-XXXXXXXXXX) |
Publishing Features¶
These features help your textbook look professional when shared on social media.
| Feature | Status | Effort | Notes |
|---|---|---|---|
| Social media preview cards | | Medium | Add - social to plugins |
| Edit page button | | Trivial | edit_uri: edit/main/docs/ configured |
Advanced Features¶
These features require significant effort, custom code, or AI assistance.
Interactive Learning¶
MicroSims are small, browser-based simulations that let students experiment with concepts.
| Feature | Status | Effort | Notes |
|---|---|---|---|
| MicroSims (interactive simulations) | | High | 18 browser-based apps for hands-on learning |
| MicroSim index catalog | | Medium | Visual gallery with cards showing all available simulations |
| Per-chapter quizzes | | High | 12 quiz files with questions aligned to learning objectives |
Learning Graph System¶
A learning graph maps every concept in the course and shows which concepts depend on others.
| Feature | Status | Effort | Notes |
|---|---|---|---|
| Course description | | Medium | Goals and outcomes using Bloom's Taxonomy levels |
| Concept list (~200-300 concepts) | | High | Every topic students need to learn, extracted with AI help |
| Learning graph CSV | | High | Spreadsheet defining which concepts depend on others |
| Learning graph JSON | | Low | Machine-readable format for the graph viewer |
| Learning graph viewer (vis-network) | | Medium | Interactive diagram where you can click and explore concepts |
| Concept taxonomy classification | | Medium | Grouping concepts into categories |
| Quality metrics report | | Low | Statistics about graph completeness and structure |
| Book metrics | | Medium | Word counts, reading time, and chapter statistics |
| Chapter metrics | | Medium | Detailed stats for each chapter individually |
| Glossary quality report | | Low | Check definitions follow standards |
| FAQ quality report | | Low | Check FAQ completeness |
| FAQ coverage gaps | | Low | Find concepts not addressed in FAQ |
| Quiz generation report | | Low | Quality report for generated quizzes |
Content Generation¶
These features involve creating the actual educational content.
| Feature | Status | Effort | Notes |
|---|---|---|---|
| Chapter content | | Very High | 12 chapters with full text, examples, and exercises |
| Sample prompts collection | | Medium | Saved AI prompts so content can be regenerated consistently |
Feature Dependencies¶
Some features require others to be implemented first.
Course Description
└── Concept List
└── Learning Graph (CSV)
├── Learning Graph (JSON)
│ └── Graph Viewer
├── Glossary
│ └── Glossary Quality Report
├── FAQ
│ ├── FAQ Quality Report
│ └── FAQ Coverage Gaps
└── Chapter Content
├── Per-Chapter Quizzes
├── Per-Chapter References
└── Book/Chapter Metrics
Cost Considerations¶
Most intelligent textbook features use free, open-source software.
| Feature Category | License Cost | Notes |
|---|---|---|
| MkDocs Material | Free (MIT) | Static site generator and theme |
| Python dependencies | Free | Pillow and CairoSVG for social preview images |
| vis-network.js | Free (MIT) | JavaScript library for interactive graph diagrams |
| p5.js | Free (LGPL) | JavaScript library for creative coding and simulations |
| KaTeX | Free (MIT) | Fast math equation rendering in the browser |
| AI image generation | $20+/month | Required for creating infographics with DALL-E or ImageFX |
| Claude/ChatGPT for content | Varies | Used to draft chapters, quizzes, and glossary entries |
Quick Start: Adding Missing Features¶
Start with the easiest wins and work your way up.
Highest Impact, Lowest Effort¶
These can be done in under an hour:
- License page - Copy the standard Creative Commons template
- Contact page - Add author email or feedback form
- Edit page button - One line in
mkdocs.ymlenables "Suggest an edit" links - Social media cards - Auto-generate preview images when shared
Medium Effort, High Value¶
These use Claude Code skills to generate content:
- Glossary - Use the glossary-generator skill to create searchable definitions
- FAQ - Use the faq-generator skill to answer common student questions
- Book metrics - Use the book-metrics-generator skill to track completeness
- Per-chapter quizzes - Use the quiz-generator skill for auto-graded practice
High Effort, Transformative¶
These take more time but significantly enhance the learning experience:
- Additional MicroSims - Each simulation takes 2-4 hours; aim for 10-20 total
- AI-generated infographics - Requires paid image generation subscription
- Instructor's guide - Helps teachers adopt your textbook
Generated by book-installer feature-checklist-generator
Last updated: February 2026