Markdown Quiz Generator

🚀 Introduction

The Markdown Quiz Generator is a powerful tool that allows you to create interactive quizzes from simple Markdown files. This means you can leverage all the formatting capabilities of Markdown - including structured text, bold, italic, tables, and more - to create engaging quiz experiences.

📝 How It Works

The process is straightforward:

1. Create a quiz in Markdown format
2. Run the generator
3. Get an interactive HTML quiz ready to share or embed

From Markdown File:

To Interactive Quiz:

An animated example of the generated interactive quiz

📊 Sample Quiz

Below is an example of a generated quiz. You can interact with it directly:

✨ Features

• Markdown Support: Use all standard Markdown syntax for rich text formatting
• Multiple Question Types: Support for multiple choice, true/false, and other question formats
• Interactive UI: Engaging user interface with immediate feedback
• Customizable: Easy to adapt to your specific needs
• Embeddable: Include quizzes in websites, learning management systems, or documents

🛠️ Getting Started

Prerequisites

• Node.js installed on your system
• Basic knowledge of Markdown syntax

Installation

# Clone the repository
git clone https://github.com/osandadeshan/markdown-quiz-generator.git

# Navigate to the project directory
cd markdown-quiz-generator

# Install dependencies
npm installCopy to clipboardErrorCopied

Creating Your First Quiz

1. Create a new Markdown file with your quiz content
2. Follow the format shown in the example above
3. Run the generator:

npm run generate -- path/to/your/quiz.mdCopy to clipboardErrorCopied

4. Find your generated quiz in the generated-quizzes folder

📋 Markdown Format

Your quiz Markdown file should follow this general structure:

# Quiz Title

## Question 1
What is the capital of France?
- [ ] London
- [x] Paris
- [ ] Berlin
- [ ] Madrid

## Question 2
True or False: The Earth is flat.
- [ ] True
- [x] FalseCopy to clipboardErrorCopied

🔗 Additional Resources

• GitHub Repository
• Documentation
• Issue Tracker

🤝 Contributing

Contributions are welcome! If you have ideas to improve the Markdown Quiz Generator, please:

1. Fork the repository
2. Create a new branch
3. Make your changes
4. Submit a pull request

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.