Initial commit
This commit is contained in:
38
commands/anki.md
Normal file
38
commands/anki.md
Normal file
@@ -0,0 +1,38 @@
|
||||
---
|
||||
description: Export quiz to Anki CSV format
|
||||
argument-hint: input.md output.csv
|
||||
---
|
||||
|
||||
Export quiz markdown to Anki CSV format (AllInOne or Basic).
|
||||
|
||||
## Usage
|
||||
|
||||
```bash
|
||||
markdown-quiz-exporter-tool anki INPUT.md OUTPUT.csv [OPTIONS]
|
||||
```
|
||||
|
||||
## Arguments
|
||||
|
||||
- `INPUT.md`: Quiz markdown file (required)
|
||||
- `OUTPUT.csv`: Output CSV file (required)
|
||||
- `--quiz`: AllInOne quiz format (default)
|
||||
- `--recall`: Basic recall format
|
||||
- `--force` / `-f`: Overwrite existing file
|
||||
- `-v/-vv/-vvv`: Verbosity (INFO/DEBUG/TRACE)
|
||||
|
||||
## Examples
|
||||
|
||||
```bash
|
||||
# Export as quiz (default)
|
||||
markdown-quiz-exporter-tool anki quiz.md cards.csv
|
||||
|
||||
# Export as recall
|
||||
markdown-quiz-exporter-tool anki quiz.md cards.csv --recall
|
||||
|
||||
# Overwrite existing
|
||||
markdown-quiz-exporter-tool anki quiz.md cards.csv --force
|
||||
```
|
||||
|
||||
## Output
|
||||
|
||||
CSV with AllInOne (quiz) or Basic (recall) format.
|
||||
36
commands/flashhero.md
Normal file
36
commands/flashhero.md
Normal file
@@ -0,0 +1,36 @@
|
||||
---
|
||||
description: Export quiz to Flashcard Hero TSV format
|
||||
argument-hint: input.md output.tsv
|
||||
---
|
||||
|
||||
Export quiz markdown to Flashcard Hero TSV format.
|
||||
|
||||
## Usage
|
||||
|
||||
```bash
|
||||
markdown-quiz-exporter-tool flashhero INPUT.md OUTPUT.tsv [OPTIONS]
|
||||
```
|
||||
|
||||
## Arguments
|
||||
|
||||
- `INPUT.md`: Quiz markdown file (required)
|
||||
- `OUTPUT.tsv`: Output TSV file (required)
|
||||
- `--force` / `-f`: Overwrite existing file
|
||||
- `-v/-vv/-vvv`: Verbosity (INFO/DEBUG/TRACE)
|
||||
|
||||
## Examples
|
||||
|
||||
```bash
|
||||
# Basic export
|
||||
markdown-quiz-exporter-tool flashhero quiz.md flashcards.tsv
|
||||
|
||||
# Overwrite existing
|
||||
markdown-quiz-exporter-tool flashhero quiz.md flashcards.tsv --force
|
||||
|
||||
# With verbose output
|
||||
markdown-quiz-exporter-tool flashhero quiz.md flashcards.tsv -vv
|
||||
```
|
||||
|
||||
## Output
|
||||
|
||||
TSV file with: Question<TAB>Answer format.
|
||||
44
commands/help.md
Normal file
44
commands/help.md
Normal file
@@ -0,0 +1,44 @@
|
||||
---
|
||||
description: Show help information for markdown-quiz-exporter-tool
|
||||
argument-hint: command
|
||||
---
|
||||
|
||||
Display help information for markdown-quiz-exporter-tool CLI commands.
|
||||
|
||||
## Usage
|
||||
|
||||
```bash
|
||||
# Show general help
|
||||
markdown-quiz-exporter-tool --help
|
||||
|
||||
# Show command-specific help
|
||||
markdown-quiz-exporter-tool COMMAND --help
|
||||
|
||||
# Show version
|
||||
markdown-quiz-exporter-tool --version
|
||||
```
|
||||
|
||||
## Arguments
|
||||
|
||||
- `COMMAND` (optional): Specific command to get help for
|
||||
- `--help` / `-h`: Show help information
|
||||
- `--version` / `-v`: Show version information
|
||||
|
||||
## Examples
|
||||
|
||||
```bash
|
||||
# General help
|
||||
markdown-quiz-exporter-tool --help
|
||||
|
||||
# Command help
|
||||
markdown-quiz-exporter-tool quiz-html --help
|
||||
markdown-quiz-exporter-tool flashhero --help
|
||||
markdown-quiz-exporter-tool anki --help
|
||||
|
||||
# Version information
|
||||
markdown-quiz-exporter-tool --version
|
||||
```
|
||||
|
||||
## Output
|
||||
|
||||
Displays usage information, available commands, and options.
|
||||
37
commands/quiz-html.md
Normal file
37
commands/quiz-html.md
Normal file
@@ -0,0 +1,37 @@
|
||||
---
|
||||
description: Generate interactive HTML quiz from markdown
|
||||
argument-hint: input.md output.html
|
||||
---
|
||||
|
||||
Generate self-contained interactive HTML quiz page.
|
||||
|
||||
## Usage
|
||||
|
||||
```bash
|
||||
markdown-quiz-exporter-tool quiz-html INPUT.md OUTPUT.html --title "TITLE" [OPTIONS]
|
||||
```
|
||||
|
||||
## Arguments
|
||||
|
||||
- `INPUT.md`: Quiz markdown file (required)
|
||||
- `OUTPUT.html`: Output HTML file (required)
|
||||
- `--title "TITLE"`: Quiz title (required)
|
||||
- `--force` / `-f`: Overwrite existing file
|
||||
- `-v/-vv/-vvv`: Verbosity (INFO/DEBUG/TRACE)
|
||||
|
||||
## Examples
|
||||
|
||||
```bash
|
||||
# Generate quiz HTML
|
||||
markdown-quiz-exporter-tool quiz-html quiz.md quiz.html --title "My Quiz"
|
||||
|
||||
# Overwrite existing
|
||||
markdown-quiz-exporter-tool quiz-html quiz.md quiz.html --title "Quiz" --force
|
||||
|
||||
# With verbose output
|
||||
markdown-quiz-exporter-tool quiz-html quiz.md quiz.html --title "Quiz" -vv
|
||||
```
|
||||
|
||||
## Output
|
||||
|
||||
Self-contained HTML with embedded quiz, CSS, and JavaScript.
|
||||
72
commands/validate.md
Normal file
72
commands/validate.md
Normal file
@@ -0,0 +1,72 @@
|
||||
---
|
||||
description: Validate quiz markdown file format
|
||||
argument-hint: input.md
|
||||
---
|
||||
|
||||
Validate quiz markdown file format and show statistics.
|
||||
|
||||
## Usage
|
||||
|
||||
```bash
|
||||
markdown-quiz-exporter-tool validate INPUT.md [OPTIONS]
|
||||
```
|
||||
|
||||
## Arguments
|
||||
|
||||
- `INPUT.md`: Quiz markdown file to validate (required)
|
||||
- `-v/-vv/-vvv`: Verbosity (INFO/DEBUG/TRACE)
|
||||
|
||||
## Examples
|
||||
|
||||
```bash
|
||||
# Basic validation
|
||||
markdown-quiz-exporter-tool validate quiz.md
|
||||
|
||||
# With verbose output for debugging
|
||||
markdown-quiz-exporter-tool validate quiz.md -vv
|
||||
```
|
||||
|
||||
## Output
|
||||
|
||||
### On Success
|
||||
|
||||
Shows statistics about the quiz:
|
||||
- Total question count
|
||||
- Single choice vs multiple choice breakdown
|
||||
- Answer statistics (total, average per question, correct count)
|
||||
- Explanation coverage
|
||||
|
||||
### On Error
|
||||
|
||||
Shows detailed error information:
|
||||
- Exact line number where error occurred
|
||||
- Problematic line content
|
||||
- Context lines (2 before, 2 after)
|
||||
- Clear error message with fix suggestions
|
||||
- Question block number
|
||||
|
||||
## Common Errors
|
||||
|
||||
**Mixed answer types:**
|
||||
```
|
||||
Error at line 5: Cannot mix ( ) and [ ] formats in same question
|
||||
```
|
||||
Fix: Use consistent format - either `( )` for single choice OR `[ ]` for multiple choice
|
||||
|
||||
**No correct answer:**
|
||||
```
|
||||
Error at line 3: No correct answer marked. Use (X) or [X]
|
||||
```
|
||||
Fix: Mark at least one answer with `(X)` or `[X]`
|
||||
|
||||
**No answers found:**
|
||||
```
|
||||
Error at line 2: No answers found. Expected format: '- (X) text'
|
||||
```
|
||||
Fix: Add answer options in format `- (X) answer` or `- [X] answer`
|
||||
|
||||
**No question text:**
|
||||
```
|
||||
Error at line 1: No question text found
|
||||
```
|
||||
Fix: Add question text before answer options
|
||||
Reference in New Issue
Block a user