This software supports automating tutorials via templating and predefined templates. Values for questions are injected into templates programmatically which can then be stitched together into a final tutorial.
You can either predefine a whole tutorial with a set list of questions or select a random number of questions by using:
import numpy.random
import importlibSupported file formats include:
- HTML
- PDF (Quarto + Latex)
- DOCX (Pandoc)
⚠️ Warning: DOCX file tables Pandoc struggles to render Markdown/LaTeX tables into Word documents. Use HTML output and manually adjust missing values.
- Quarto
- Pandoc
git clone git@github.com:AlexTabble/TutorialCreator.gitcd TutorialCreator
python -m venv .venv
.\.venv\Scripts\python.exe -m pip install --upgrade pip
.\.venv\Scripts\python.exe -m pip install -r requirements.txt
.\.venv\Scripts\python.exe -m pip install -e .Double click either .bat file to run the program. To create a desktop shortcut,
you can create a .bat file on the desktop which executes the specific file like:
@echo off
call "%USERPROFILE%\path_to_bat_scripts.bat"
pause.
├── configs
├── generated_tutorials
├── gui.py
├── main.py
├── pyproject.toml
├── README.md
├── requirements.txt
├── run_gui.bat
├── run_st.bat
├── src
│ ├── tutorialcreator
│ │ ├── config
│ │ ├── core
│ │ ├── __init__.py
│ │ ├── logger.py
│ │ ├── renderer
│ │ ├── tutorials
│ │ └── utils.py
├── st.py
├── templates
│ ├── header_templates
│ ├── macros
│ ├── memo_templates
│ └── question_templates
└── uv.lock