MkDocs Free-Text Questions Plugin

A comprehensive MkDocs plugin for adding interactive free-text questions and assessments to your documentation. Perfect for educational content, tutorials, and training materials.

✨ Key Features

🎯 Interactive Questions: Add free-text input questions directly to your documentation
📝 Multi-Question Assessments: Create comprehensive assessments with multiple questions
🎨 Rich Content Support: Questions support Mermaid diagrams, code blocks, images, and markdown
✨ Modern Syntax: Clean --- separator with comma-separated configuration (v1.1.0+)
🌓 Material Theme Integration: Seamless integration with automatic dark/light mode support
🔀 Question Shuffling: Optional randomization of assessment question order
📊 Character Counting: Optional character counter for text inputs
💡 Sample Answers: Show/hide sample answers for learning reinforcement
🔍 Professional Debugging: Comprehensive logging system for troubleshooting (v1.2.0+)

🚀 Quick Start

Installation

pip install mkdocs-freetext

Basic Setup

Add the plugin to your mkdocs.yml:

plugins:
  - freetext

Your First Question (New Syntax)

!!! freetext
    What is the capital of France?
    ---
    placeholder: Enter your answer here..., marks: 2, show_answer: true, answer: Paris is the capital of France.

Installation Guide - Complete setup instructions
Live Demo - See the plugin in action with working examples
Configuration - All available options and settings
Debugging & Troubleshooting - Professional logging and issue resolution (NEW in v1.2.0)

🏆 Why Choose This Plugin?

Educational Focus: Built specifically for learning and assessment
Modern Design: Beautiful, responsive interface that works everywhere
Rich Content: Support for diagrams, code, images, and complex markdown
Developer Friendly: Clean API, extensive documentation, and active maintenance
Production Ready: Used in educational institutions and corporate training

Ready to get started? Check out our Live Demo to see the plugin in action!