https://github.com/basnijholt/tuitorial
Create beautiful terminal-based code tutorials with syntax highlighting and interactive navigation.
https://github.com/basnijholt/tuitorial
Last synced: about 1 month ago
JSON representation
Create beautiful terminal-based code tutorials with syntax highlighting and interactive navigation.
- Host: GitHub
- URL: https://github.com/basnijholt/tuitorial
- Owner: basnijholt
- License: mit
- Created: 2024-12-24T18:38:21.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-08-07T08:56:51.000Z (3 months ago)
- Last Synced: 2025-08-07T10:31:40.218Z (3 months ago)
- Language: Python
- Homepage: https://tuitorial.readthedocs.io/
- Size: 469 KB
- Stars: 504
- Watchers: 2
- Forks: 8
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Authors: AUTHORS.md
Awesome Lists containing this project
- awesome-cli-apps-in-a-csv - tuitorial - Create beautiful terminal-based code tutorials with syntax highlighting and interactive navigation. (<a name="office"></a>Office tools)
README
# Tuitorial 📚
> Create beautiful terminal-based code tutorials with syntax highlighting and interactive navigation.
[](https://tuitorial.readthedocs.io/en/latest/?badge=latest)
[](https://badge.fury.io/py/tuitorial)
[](https://pypi.org/project/tuitorial/)
[](https://github.com/basnijholt/tuitorial/actions/workflows/pytest.yml)
[](https://codecov.io/gh/basnijholt/tuitorial)
[](https://github.com/astral-sh/ruff)
[](https://github.com/basnijholt/tuitorial)
> [!NOTE]
> **tuitorial**? Typo? No, a combination of "TUI" (Terminal User Interface) and "tutorial".
[ToC] 📚
- [🎯 Features](#-features)
- [🤨 Why?](#-why)
- [📸 Recording](#-recording)
- [🚀 Installation](#-installation)
- [🎮 Quick Start](#-quick-start)
- [📖 Usage](#-usage)
- [📚 Multiple Chapters](#-multiple-chapters)
- [🚶 Steps](#-steps)
- [🎯 Focus Types](#-focus-types)
- [Literal Match](#literal-match)
- [Regular Expression](#regular-expression)
- [Line Number](#line-number)
- [Range](#range)
- [Starts With](#starts-with)
- [Between](#between)
- [Line Containing](#line-containing)
- [Markdown](#markdown)
- [Syntax Highlighting](#syntax-highlighting)
- [🎨 Styling](#-styling)
- [🔄 Live Reloading (Development Mode)](#-live-reloading-development-mode)
- [🎨 Custom Highlighting Patterns](#-custom-highlighting-patterns)
- [✨ Multiple Highlights per Step](#-multiple-highlights-per-step)
- [🖼️ Displaying Images](#-displaying-images)
- [ImageStep](#imagestep)
- [Image Positioning and Sizing](#image-positioning-and-sizing)
- [Alignment](#alignment)
- [🎬 Title Slide](#-title-slide)
- [📖 Helper Functions](#-helper-functions)
- [`create_bullet_point_chapter`](#create_bullet_point_chapter)
- [⌨️ Controls](#-controls)
- [🧪 Development](#-development)
- [🤝 Contributing](#-contributing)
- [📝 License](#-license)
- [🙏 Acknowledgments](#-acknowledgments)
- [📚 Similar Projects](#-similar-projects)
- [🐛 Troubleshooting](#-troubleshooting)
## 🎯 Features
- 🎨 **Rich Syntax Highlighting:** Customizable styles, wide language support.
- 🔍 **Multiple Focus Types:** Literal, regex, line, range, startswith, between, line containing, and syntax highlighting.
- 📝 **Step-by-Step Tutorials:** Interactive, sequential steps with clear descriptions.
- 🖼️ **Multimedia:** Markdown rendering and image embedding.
- ⌨️ **Interactive Navigation:** Intuitive keyboard and scroll controls.
- 🖥️ **Beautiful Terminal UI:** Powered by [Textual](https://textual.textualize.io/).
- 🚀 **Customizable:** Python or YAML configuration, custom highlighting.
- 🎓 **Beginner Friendly:** Simple API, no Textual knowledge required.
- ⚡ **Title Slide:** Eye-catching ASCII art title slides.
- 🔄 **Live Reloading:** Automatically refreshes app on YAML update.
## 🤨 Why?
99.9% shouldn't use `tuitorial`. But those 0.1% that should, will love it.
- **Escape the Tyranny of Slide Decks:** Ditch PowerPoint, Google Slides, and Beamer. Embrace the terminal.
- **Code is King:** Keep the focus on your code, where it belongs.
- **Interactive and Engaging:** Step-by-step walkthroughs with interactive navigation.
- **Reproducible and Versionable:** Define tutorials in code (Python or YAML) for easy tracking and updates.
- **Lightweight and Fast:** No more bloated presentation software.
- **Perfect for Nerds:** Ideal for explaining code, technical workshops, interactive documentation, and anyone who loves the terminal.
- **Parameterize:** Create dynamic tutorials driven by code snippets and focus points.
## 📸 Recording
https://github.com/user-attachments/assets/53a0cdff-ed1b-479f-b94c-6a7b113bd8b3
This is a recording of the [`examples/pipefunc.yaml`](./examples/pipefunc.yaml) tutorial of the [`pipefunc` package](https://github.com/pipefunc/pipefunc).
## 🚀 Installation
```bash
pip install tuitorial
```
## 🎮 Quick Start
> [!TIP]
> Have `uv` installed? Run the following command to see a quick example:
> `uvx tuitorial https://raw.githubusercontent.com/basnijholt/tuitorial/refs/heads/main/examples/pipefunc.yaml`
Python
```python markdown-code-runner
from tuitorial import Chapter, Step, TuitorialApp, Focus
from rich.style import Style
# Your code to present
code = '''
def hello(name: str) -> str:
return f"Hello, {name}!"
def main():
print(hello("World"))
'''
# Define tutorial steps
steps = [
Step(
"Function Definition",
[Focus.regex(r"def hello.*:$", style="bold yellow")]
),
Step(
"Return Statement",
[Focus.literal('return f"Hello, {name}!"', style="bold green")]
),
Step(
"Main Function",
[Focus.range(code.find("def main"), len(code), style="bold blue")]
),
]
# Create a chapter
chapter = Chapter("Basic Example", code, steps)
# Run the tutorial
app = TuitorialApp([chapter])
app.run()
```
YAML
```yaml
chapters:
- title: "Basic Example"
code: |
def hello(name: str) -> str:
return f"Hello, {name}!"
def main():
print(hello("World"))
steps:
- description: "Function Definition"
focus:
- type: regex
pattern: "def hello.*:$"
style: "bold yellow"
- description: "Return Statement"
focus:
- type: literal
text: 'return f"Hello, {name}!"'
style: "bold green"
- description: "Main Function"
focus:
- type: range
start: 26 # Calculated index for "def main"
end: 53 # Calculated length of the code
style: "bold blue"
```
To run the YAML example:
1. Save the YAML content as a `.yaml` file (e.g., `tuitorial.yaml`).
2. Either:
- Use the provided `tuitorial.run_from_yaml(...)` function:
- Run `tuitorial --watch tuitorial.yaml` from the command line.
```bash
# From the command line
tuitorial --watch tuitorial.yaml
```
or
```python
# In a separate Python file (e.g., run_yaml.py)
from tuitorial.parse_yaml import run_from_yaml
run_from_yaml("tuitorial.yaml")
```
## 📖 Usage
### 📚 Multiple Chapters
Python
```python markdown-code-runner
# First chapter
chapter1_code = '''
def greet(name: str) -> str:
return f"Hello, {name}!"
'''
chapter1_steps = [
Step("Greeting Function", [Focus.regex(r"def greet.*:$")]),
Step("Return Statement", [Focus.literal('return f"Hello, {name}!"')]),
]
chapter1 = Chapter("Greetings", chapter1_code, chapter1_steps)
# Second chapter
chapter2_code = '''
def farewell(name: str) -> str:
return f"Goodbye, {name}!"
'''
chapter2_steps = [
Step("Farewell Function", [Focus.regex(r"def farewell.*:$")]),
Step("Return Statement", [Focus.literal('return f"Goodbye, {name}!"')]),
]
chapter2 = Chapter("Farewells", chapter2_code, chapter2_steps)
# Run tutorial with multiple chapters
app = TuitorialApp([chapter1, chapter2])
app.run()
```
YAML
```yaml
chapters:
- title: "Greetings"
code: |
def greet(name: str) -> str:
return f"Hello, {name}!"
steps:
- description: "Greeting Function"
focus:
- type: regex
pattern: "def greet.*:$"
- description: "Return Statement"
focus:
- type: literal
text: 'return f"Hello, {name}!"'
- title: "Farewells"
code: |
def farewell(name: str) -> str:
return f"Goodbye, {name}!"
steps:
- description: "Farewell Function"
focus:
- type: regex
pattern: "def farewell.*:$"
- description: "Return Statement"
focus:
- type: literal
text: 'return f"Goodbye, {name}!"'
```
### 🚶 Steps
Each step in a tutorial consists of a description and a list of focuses.
**Python:**
```python markdown-code-runner
Step(
"Step Description", # Shown in the UI
[
Focus.literal("some text"), # One or more Focus objects
Focus.regex(r"pattern.*"), # Can combine different focus types
]
)
```
**YAML:**
```yaml
steps:
- description: "Step Description"
focus:
- type: literal
text: "some text"
- type: regex
pattern: "pattern.*"
```
### 🎯 Focus Types
#### Literal Match
**Python:**
```python markdown-code-runner
Focus.literal("def", style="bold yellow")
Focus.literal("def", style="bold yellow", match_index=[0, 2]) # Highlight the first and third "def"
```
**YAML:**
```yaml
focus:
- type: literal
text: "def"
style: "bold yellow"
- type: literal
text: "def"
style: "bold yellow"
match_index: [0, 2] # Highlight the first and third "def"
```
**`match_index` note:**
- If provided as an integer, only highlight the nth match (0-based).
- If provided as a list of integers, highlight the matches corresponding to those indices.
- If None, highlight all matches.
#### Regular Expression
**Python:**
```python markdown-code-runner
Focus.regex(r"def \w+\(.*\):", style="bold green")
```
**YAML:**
```yaml
focus:
- type: regex
pattern: "def \\w+\\(.*\\):"
style: "bold green"
```
#### Line Number
**Python:**
```python markdown-code-runner
Focus.line(1, style="bold blue") # Highlight first line
```
**YAML:**
```yaml
focus:
- type: line
line_number: 1
style: "bold blue"
```
#### Range
Highlights a specific range of characters within the code based on their indices (0-based).
**Python:**
```python markdown-code-runner
Focus.range(0, 10, style="bold magenta") # Highlight first 10 characters
```
**YAML:**
```yaml
focus:
- type: range
start: 0
end: 10
style: "bold magenta"
```
#### Starts With
Highlights lines starting with the specified text. Can be configured to match from the start of any line or only at the start of the line.
**Python:**
```python markdown-code-runner
Focus.startswith("import", style="bold blue", from_start_of_line=True)
Focus.startswith("from", style="bold blue", from_start_of_line=False)
```
**YAML:**
```yaml
focus:
- type: startswith
text: "import"
style: "bold blue"
from_start_of_line: true
- type: startswith
text: "from"
style: "bold blue"
from_start_of_line: false
```
#### Between
Highlights text between two specified patterns. Supports inclusive or exclusive bounds, multiline matching, and greedy or non-greedy matching.
**Python:**
```python markdown-code-runner
Focus.between("start_function", "end_function", style="bold blue", inclusive=True, multiline=True)
```
**YAML:**
```yaml
focus:
- type: between
start_pattern: "start_function"
end_pattern: "end_function"
style: "bold blue"
inclusive: true
multiline: true
match_index: 0 # Only highlight the first match (0-based)
greedy: true # Use greedy matching (longest possible match)
```
#### Line Containing
Highlights entire lines that contain a specified pattern, with optional inclusion of surrounding lines.
Can match either literal text or regular expressions, and can select specific matches.
**Python:**
```python markdown-code-runner
# Highlight all lines containing "def"
Focus.line_containing("def", style="bold yellow")
# Include surrounding lines
Focus.line_containing(
"def",
style="bold yellow",
lines_before=1,
lines_after=1,
)
# Use regex and only highlight second match
Focus.line_containing(
r"def \w+",
style="bold blue",
regex=True,
match_index=1,
)
```
**YAML:**
```yaml
focus:
- type: line_containing
pattern: "def"
style: "bold yellow"
lines_before: 1 # optional: include line before match
lines_after: 1 # optional: include line after match
regex: false # optional: treat pattern as regex
match_index: 0 # optional: only highlight first match (0-based)
```
The `line_containing` focus type is particularly useful for:
- Highlighting function definitions and their body
- Showing imports and their surrounding context
- Focusing on specific sections of code while maintaining readability
- Matching patterns across multiple lines with surrounding context
#### Markdown
Displays the content as Markdown instead of code, using Textual's built-in `Markdown` widget. Only one `markdown` focus is allowed per step, and it will take precedence over any other focus types.
**Python:**
```python markdown-code-runner
Focus.markdown()
```
**YAML:**
```yaml
focus:
- type: markdown
```
#### Syntax Highlighting
Uses Rich's built-in syntax highlighting for the entire code or specific lines. Only one `syntax` focus is allowed per step, and it will take precedence over any other focus types besides `markdown`.
**Python:**
```python markdown-code-runner
# Highlight all code
Focus.syntax(theme="monokai", line_numbers=True)
# Highlight specific lines
Focus.syntax(
theme="monokai",
start_line=0,
end_line=3,
)
```
**YAML:**
```yaml
focus:
- type: syntax
lexer: "python" # optional: language to highlight (default: python)
theme: "monokai" # optional: color theme
line_numbers: true # optional: show line numbers
start_line: 0 # optional: first line to highlight
end_line: 3 # optional: last line to highlight
```
### 🎨 Styling
Styles can be customized using Rich's style syntax:
**Python:**
```python markdown-code-runner
from rich.style import Style
# Using string syntax
Focus.literal("def", style="bold yellow")
# Using Style object
Focus.literal("def", style=Style(bold=True, color="yellow"))
```
**YAML:**
```yaml
focus:
- type: literal
text: "def"
style: "bold yellow" # Using string syntax
- type: literal
text: "def"
style: "bold color(yellow)" # Using Style object
```
### 🔄 Live Reloading (Development Mode)
`tuitorial` offers a convenient development mode that automatically reloads your tutorial whenever you make changes to the YAML configuration file. This allows you to iterate quickly on your tutorial's content and see your changes reflected in real-time without manually restarting the application.
**Usage:**
To enable live reloading, use the `--watch` (or `-w`) flag when running `tuitorial` from the command line:
```bash
tuitorial tutorial.yaml --watch
```
or
```bash
tuitorial tutorial.yaml -w
```
**How it Works:**
When you run `tuitorial` with the `--watch` flag, it will monitor the specified YAML file for any modifications. If a change is detected, `tuitorial` will automatically:
1. Parse the updated YAML configuration.
2. Reload the tutorial content within the running application.
3. Preserve the current chapter and step, so you can continue where you left off.
### 🎨 Custom Highlighting Patterns
**Python:**
Python
```python markdown-code-runner
from tuitorial import TuitorialApp, Focus
from rich.style import Style
# Define custom styles
FUNCTION_STYLE = Style(color="bright_yellow", bold=True)
ARGUMENT_STYLE = Style(color="bright_green", italic=True)
# Your code to present
code = '''
def hello(name: str) -> str:
return f"Hello, {name}!"
'''
# Create focused patterns
patterns = [
Focus.regex(r"def \w+", style=FUNCTION_STYLE),
Focus.regex(r"\([^)]*\)", style=ARGUMENT_STYLE),
]
# Create tutorial step
tutorial_steps = [
Step("Function Definition", patterns),
]
# Create a chapter
chapter = Chapter("Custom Patterns", code, tutorial_steps)
# Run the tutorial
app = TuitorialApp([chapter])
app.run()
```
YAML
```yaml
chapters:
- title: "Custom Patterns"
code: |
def hello(name: str) -> str:
return f"Hello, {name}!"
steps:
- description: "Function Definition"
focus:
- type: regex
pattern: "def \\w+"
style: "bright_yellow bold"
- type: regex
pattern: "\\([^)]*\\)"
style: "bright_green italic"
```
### ✨ Multiple Highlights per Step
**Python:**
Python
```python markdown-code-runner
from tuitorial import Chapter, Step, TuitorialApp, Focus
from rich.style import Style
# Your code to present
code = '''
def hello(name: str) -> str:
return f"Hello, {name}!"
'''
tutorial_steps = [
Step(
"Input/Output",
[
Focus.literal("name", style="bold cyan"),
Focus.regex(r"->.*$", style="bold yellow"),
]
),
Step(
"Complex Example",
[
Focus.literal("def", style="bold yellow"),
Focus.regex(r"\(.*\)", style="italic green"), # Highlight function arguments
Focus.line(2, style="underline blue"), # Highlight the second line
],
),
]
# Create a chapter
chapter = Chapter("Multiple Highlights", code, tutorial_steps)
# Run the tutorial
app = TuitorialApp([chapter])
app.run()
```
YAML
```yaml
chapters:
- title: "Multiple Highlights"
code: |
def hello(name: str) -> str:
return f"Hello, {name}!"
steps:
- description: "Input/Output"
focus:
- type: literal
text: "name"
style: "bold cyan"
- type: regex
pattern: "->.*$"
style: "bold yellow"
```
### 🖼️ Displaying Images
`tuitorial` supports displaying images within your tutorials using the `ImageStep` class.
This allows you to incorporate visual aids, diagrams, or any other images to enhance your presentations.
#### ImageStep
The `ImageStep` class takes the path or URL to an image file (or a PIL Image object) and a description as input.
**Python:**
```python markdown-code-runner
from pathlib import Path
from tuitorial import Chapter, ImageStep, TuitorialApp
# Path to your image
image_path = Path("path/to/your/image.png")
# Define an ImageStep
image_step = ImageStep("Displaying an example image", image_path)
# Create a chapter with the image step
chapter = Chapter("Image Example", "", [image_step])
# Run the tutorial
app = TuitorialApp([chapter])
app.run()
```
**YAML:**
```yaml
chapters:
- title: "Image Example"
steps:
- description: "Displaying an example image"
image: "path/to/your/image.png" # or URL
```
#### Image Positioning and Sizing
You can control the size of the image using the `width` and `height` properties when creating the `Image` widget within the `ImageStep`. These properties accept either integer values (for pixel dimensions) or strings representing percentages (relative to the container's size).
**Python:**
```python markdown-code-runner
from pathlib import Path
from textual_image.widget import Image
from tuitorial import Chapter, ImageStep, TuitorialApp
image_path = Path("path/to/your/image.png")
# Set fixed width in cells and auto height
image_step_fixed = ImageStep("Fixed Size Image", image_path, width=300, height="auto")
# Set width as a percentage of the container and height in cells
image_step_percentage = ImageStep("Percentage Width Image", image_path, width="50%", height=200)
chapter = Chapter("Image Examples", "", [image_step_fixed, image_step_percentage])
app = TuitorialApp([chapter])
app.run()
```
**YAML:**
```yaml
chapters:
- title: "Image Examples"
steps:
- description: "Fixed Size Image"
image: "path/to/your/image.png"
width: 300 # Fixed width in cells
height: "auto" # Auto height
- description: "Percentage Width Image"
image: "path/to/your/image.png"
width: "50%" # Width as a percentage
height: 200 # Fixed height in cells
```
#### Alignment
By default, images are aligned to the center.
You can align images to the left or right by setting `halign` to `"left"` or `"right"` respectively when creating the `ImageStep`.
```yaml
chapters:
- title: "Image Alignment"
steps:
- description: "Left Aligned Image"
image: "path/to/your/image.png"
halign: "left"
- description: "Right Aligned Image"
image: "path/to/your/image.png"
halign: "right"
```
### 🎬 Title Slide
`tuitorial` allows you to create a visually appealing title slide for your tutorial using ASCII art generated by [PyFiglet](https://github.com/pwaller/pyfiglet).
**Python:**
```python markdown-code-runner
from tuitorial import TuitorialApp, TitleSlide
title_slide = TitleSlide(
"My Tutorial", # Title text (required)
subtitle="An Awesome Tutorial", # Optional subtitle
font="slant", # Optional: PyFiglet font (see available fonts below)
gradient="lava", # Optional: Gradient color (see available gradients below)
)
app = TuitorialApp([], title_slide=title_slide)
app.run()
```
**YAML:**
```yaml
title_slide:
title: "My Tutorial"
subtitle: "An Awesome Tutorial"
font: "slant"
gradient: "lava"
chapters:
# ... your chapters ...
```
**Available Fonts:**
You can choose from a variety of fonts provided by PyFiglet. Some popular options include:
- `slant`
- `3-d`
- `3x5`
- `5lineoblique`
- `acrobatic`
- `avatar`
- `banner`
- `big`
- `block`
- `bubble`
- `digital`
- `doom`
- `isometric1`
- `letters`
- `rectangles`
- `standard`
You can find a full list of available fonts in the [PyFiglet documentation](https://github.com/pwaller/pyfiglet/tree/master/pyfiglet/fonts) or by running:
```python
import pyfiglet
print(pyfiglet.FigletFont.getFonts())
```
Click to see all
- `1943____`
- `1row`
- `3-d`
- `3d-ascii`
- `3d_diagonal`
- `3x5`
- `4max`
- `4x4_offr`
- `5lineoblique`
- `5x7`
- `5x8`
- `64f1____`
- `6x10`
- `6x9`
- `a_zooloo`
- `acrobatic`
- `advenger`
- `alligator`
- `alligator2`
- `alpha`
- `alphabet`
- `amc_3_line`
- `amc_3_liv1`
- `amc_aaa01`
- `amc_neko`
- `amc_razor`
- `amc_razor2`
- `amc_slash`
- `amc_slider`
- `amc_thin`
- `amc_tubes`
- `amc_untitled`
- `ansi_regular`
- `ansi_shadow`
- `aquaplan`
- `arrows`
- `asc_____`
- `ascii___`
- `ascii_new_roman`
- `assalt_m`
- `asslt__m`
- `atc_____`
- `atc_gran`
- `avatar`
- `b1ff`
- `b_m__200`
- `banner`
- `banner3`
- `banner3-D`
- `banner4`
- `barbwire`
- `basic`
- `battle_s`
- `battlesh`
- `baz__bil`
- `bear`
- `beer_pub`
- `bell`
- `benjamin`
- `big`
- `big_money-ne`
- `big_money-nw`
- `big_money-se`
- `big_money-sw`
- `bigchief`
- `bigfig`
- `binary`
- `block`
- `blocks`
- `blocky`
- `bloody`
- `bolger`
- `braced`
- `bright`
- `brite`
- `briteb`
- `britebi`
- `britei`
- `broadway`
- `broadway_kb`
- `bubble`
- `bubble__`
- `bubble_b`
- `bulbhead`
- `c1______`
- `c2______`
- `c_ascii_`
- `c_consen`
- `calgphy2`
- `caligraphy`
- `calvin_s`
- `cards`
- `catwalk`
- `caus_in_`
- `char1___`
- `char2___`
- `char3___`
- `char4___`
- `charact1`
- `charact2`
- `charact3`
- `charact4`
- `charact5`
- `charact6`
- `characte`
- `charset_`
- `chartr`
- `chartri`
- `chiseled`
- `chunky`
- `clb6x10`
- `clb8x10`
- `clb8x8`
- `cli8x8`
- `clr4x6`
- `clr5x10`
- `clr5x6`
- `clr5x8`
- `clr6x10`
- `clr6x6`
- `clr6x8`
- `clr7x10`
- `clr7x8`
- `clr8x10`
- `clr8x8`
- `coil_cop`
- `coinstak`
- `cola`
- `colossal`
- `com_sen_`
- `computer`
- `contessa`
- `contrast`
- `convoy__`
- `cosmic`
- `cosmike`
- `cour`
- `courb`
- `courbi`
- `couri`
- `crawford`
- `crawford2`
- `crazy`
- `cricket`
- `cursive`
- `cyberlarge`
- `cybermedium`
- `cybersmall`
- `cygnet`
- `d_dragon`
- `danc4`
- `dancing_font`
- `dcs_bfmo`
- `decimal`
- `deep_str`
- `def_leppard`
- `defleppard`
- `delta_corps_priest_1`
- `demo_1__`
- `demo_2__`
- `demo_m__`
- `devilish`
- `diamond`
- `diet_cola`
- `digital`
- `doh`
- `doom`
- `dos_rebel`
- `dotmatrix`
- `double`
- `double_shorts`
- `drpepper`
- `druid___`
- `dwhistled`
- `e__fist_`
- `ebbs_1__`
- `ebbs_2__`
- `eca_____`
- `efti_robot`
- `eftichess`
- `eftifont`
- `eftipiti`
- `eftirobot`
- `eftitalic`
- `eftiwall`
- `eftiwater`
- `electronic`
- `elite`
- `epic`
- `etcrvs__`
- `f15_____`
- `faces_of`
- `fair_mea`
- `fairligh`
- `fantasy_`
- `fbr12___`
- `fbr1____`
- `fbr2____`
- `fbr_stri`
- `fbr_tilt`
- `fender`
- `filter`
- `finalass`
- `fire_font-k`
- `fire_font-s`
- `fireing_`
- `flipped`
- `flower_power`
- `flyn_sh`
- `fourtops`
- `fp1_____`
- `fp2_____`
- `fraktur`
- `fun_face`
- `fun_faces`
- `funky_dr`
- `future_1`
- `future_2`
- `future_3`
- `future_4`
- `future_5`
- `future_6`
- `future_7`
- `future_8`
- `fuzzy`
- `gauntlet`
- `georgi16`
- `georgia11`
- `ghost`
- `ghost_bo`
- `ghoulish`
- `glenyn`
- `goofy`
- `gothic`
- `gothic__`
- `graceful`
- `gradient`
- `graffiti`
- `grand_pr`
- `greek`
- `green_be`
- `hades___`
- `heart_left`
- `heart_right`
- `heavy_me`
- `helv`
- `helvb`
- `helvbi`
- `helvi`
- `henry_3d`
- `heroboti`
- `hex`
- `hieroglyphs`
- `high_noo`
- `hills___`
- `hollywood`
- `home_pak`
- `horizontal_left`
- `horizontal_right`
- `house_of`
- `hypa_bal`
- `hyper___`
- `icl-1900`
- `impossible`
- `inc_raw_`
- `invita`
- `isometric1`
- `isometric2`
- `isometric3`
- `isometric4`
- `italic`
- `italics_`
- `ivrit`
- `jacky`
- `jazmine`
- `jerusalem`
- `joust___`
- `js_block_letters`
- `js_bracket_letters`
- `js_capital_curves`
- `js_cursive`
- `js_stick_letters`
- `katakana`
- `kban`
- `keyboard`
- `kgames_i`
- `kik_star`
- `knob`
- `konto`
- `konto_slant`
- `krak_out`
- `larry3d`
- `lazy_jon`
- `lcd`
- `lean`
- `letter_w`
- `letters`
- `letterw3`
- `lexible_`
- `lil_devil`
- `line_blocks`
- `linux`
- `lockergnome`
- `mad_nurs`
- `madrid`
- `magic_ma`
- `marquee`
- `master_o`
- `maxfour`
- `mayhem_d`
- `mcg_____`
- `merlin1`
- `merlin2`
- `mig_ally`
- `mike`
- `mini`
- `mirror`
- `mnemonic`
- `modern__`
- `modular`
- `morse`
- `morse2`
- `moscow`
- `mshebrew210`
- `muzzle`
- `nancyj`
- `nancyj-fancy`
- `nancyj-improved`
- `nancyj-underlined`
- `new_asci`
- `nfi1____`
- `nipples`
- `notie_ca`
- `npn_____`
- `nscript`
- `ntgreek`
- `nvscript`
- `o8`
- `octal`
- `odel_lak`
- `ogre`
- `ok_beer_`
- `old_banner`
- `os2`
- `outrun__`
- `p_s_h_m_`
- `p_skateb`
- `pacos_pe`
- `panther_`
- `patorjk's_cheese`
- `patorjk-hex`
- `pawn_ins`
- `pawp`
- `peaks`
- `pebbles`
- `pepper`
- `phonix__`
- `platoon2`
- `platoon_`
- `pod_____`
- `poison`
- `puffy`
- `puzzle`
- `pyramid`
- `r2-d2___`
- `rad_____`
- `rad_phan`
- `radical_`
- `rainbow_`
- `rally_s2`
- `rally_sp`
- `rammstein`
- `rampage_`
- `rastan__`
- `raw_recu`
- `rci_____`
- `rectangles`
- `red_phoenix`
- `relief`
- `relief2`
- `rev`
- `ripper!_`
- `road_rai`
- `rockbox_`
- `rok_____`
- `roman`
- `roman___`
- `rot13`
- `rotated`
- `rounded`
- `rowancap`
- `rozzo`
- `runic`
- `runyc`
- `sans`
- `sansb`
- `sansbi`
- `sansi`
- `santa_clara`
- `sblood`
- `sbook`
- `sbookb`
- `sbookbi`
- `sbooki`
- `script`
- `script__`
- `serifcap`
- `shadow`
- `shimrod`
- `short`
- `skate_ro`
- `skateord`
- `skateroc`
- `sketch_s`
- `sl_script`
- `slant`
- `slant_relief`
- `slide`
- `slscript`
- `sm______`
- `small`
- `small_caps`
- `small_poison`
- `small_shadow`
- `small_slant`
- `smisome1`
- `smkeyboard`
- `smscript`
- `smshadow`
- `smslant`
- `smtengwar`
- `soft`
- `space_op`
- `spc_demo`
- `speed`
- `spliff`
- `stacey`
- `stampate`
- `stampatello`
- `standard`
- `star_strips`
- `star_war`
- `starwars`
- `stealth_`
- `stellar`
- `stencil1`
- `stencil2`
- `stforek`
- `stick_letters`
- `stop`
- `straight`
- `street_s`
- `stronger_than_all`
- `sub-zero`
- `subteran`
- `super_te`
- `swamp_land`
- `swan`
- `sweet`
- `t__of_ap`
- `tanja`
- `tav1____`
- `taxi____`
- `tec1____`
- `tec_7000`
- `tecrvs__`
- `tengwar`
- `term`
- `test1`
- `the_edge`
- `thick`
- `thin`
- `this`
- `thorned`
- `threepoint`
- `ti_pan__`
- `ticks`
- `ticksslant`
- `tiles`
- `times`
- `timesofl`
- `tinker-toy`
- `tomahawk`
- `tombstone`
- `top_duck`
- `train`
- `trashman`
- `trek`
- `triad_st`
- `ts1_____`
- `tsalagi`
- `tsm_____`
- `tsn_base`
- `tty`
- `ttyb`
- `tubular`
- `twin_cob`
- `twisted`
- `twopoint`
- `type_set`
- `ucf_fan_`
- `ugalympi`
- `unarmed_`
- `univers`
- `usa_____`
- `usa_pq__`
- `usaflag`
- `utopia`
- `utopiab`
- `utopiabi`
- `utopiai`
- `varsity`
- `vortron_`
- `war_of_w`
- `wavy`
- `weird`
- `wet_letter`
- `whimsy`
- `wow`
- `xbrite`
- `xbriteb`
- `xbritebi`
- `xbritei`
- `xchartr`
- `xchartri`
- `xcour`
- `xcourb`
- `xcourbi`
- `xcouri`
- `xhelv`
- `xhelvb`
- `xhelvbi`
- `xhelvi`
- `xsans`
- `xsansb`
- `xsansbi`
- `xsansi`
- `xsbook`
- `xsbookb`
- `xsbookbi`
- `xsbooki`
- `xtimes`
- `xtty`
- `xttyb`
- `yie-ar__`
- `yie_ar_k`
- `z-pilot_`
- `zig_zag_`
- `zone7___`
**Available Gradients:**
You can choose from a variety of gradients Tuitorial provides. These are:
- `lava`
- `blue`
- `green`
- `rainbow`
- `pink`
- `ocean`
### 📖 Helper Functions
#### `create_bullet_point_chapter`
This helper function simplifies the creation of chapters that present information in a bullet-point format.
It automatically generates the code content from the list of bullet points, and each step in the generated chapter will highlight a different bullet point.
Python
```python markdown-code-runner
from rich.style import Style
from tuitorial import TuitorialApp
from tuitorial.helpers import create_bullet_point_chapter
bullet_points = [
"This is the first point.",
"Here is the second point.",
"And finally, the third point.",
]
# Create a chapter with bullet points
bullet_point_chapter = create_bullet_point_chapter(
"My Bullet Points",
bullet_points,
style=Style(color="magenta", bold=True),
)
# You can also add extra descriptive text per step:
bullet_point_chapter_with_extras = create_bullet_point_chapter(
"My Bullet Points with Extras",
bullet_points,
extras=[
"Extra info for point 1.",
"More details about point 2.",
"Final thoughts on point 3.",
],
style=Style(color="green", bold=True),
)
app = TuitorialApp([bullet_point_chapter, bullet_point_chapter_with_extras])
app.run()
```
YAML
```yaml
chapters:
- title: "My Bullet Points"
type: bullet_points
bullet_points:
- "This is the first point."
- "Here is the second point."
- "And finally, the third point."
style: "magenta bold"
- title: "My Bullet Points with Extras"
type: bullet_points
bullet_points:
- text: "This is the first point."
extra: "Extra info for point 1."
- text: "Here is the second point."
extra: "More details about point 2."
- text: "And finally, the third point."
extra: "Final thoughts on point 3."
- Fourth point without extra
style: "green bold"
```
## ⌨️ Controls
- `↑` Previous step in current chapter
- `↓` Next step in current chapter
- `→` Next chapter
- `←` Previous chapter
- `r` Reset to first step of current chapter
- `d` Toggle dim/bright background
- `q` Quit `tuitorial`
## 🧪 Development
1. Clone the repository:
```bash
git clone https://github.com/basnijholt/tuitorial.git
cd tuitorial
```
2. Create a virtual environment:
```bash
python -m venv venv
source venv/bin/activate # or `venv\Scripts\activate` on Windows
```
3. Install development dependencies:
```bash
pip install -e ".[test]"
```
4. Enable pre-commit hooks:
```bash
pre-commit install
```
5. Run tests:
```bash
pytest
```
## 🤝 Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
1. Fork the repository
2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## 📝 License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## 🙏 Acknowledgments
- [Textual](https://textual.textualize.io/) for the amazing TUI framework
- [Rich](https://rich.readthedocs.io/) for beautiful terminal formatting
## 📚 Similar Projects
- [Spiel](https://github.com/JoshKarpel/spiel) Display richly-styled presentations using your terminal (also Textual-based, more for general presentations, no focus modes like `tuitorial`).
- [present](https://github.com/vinayak-mehta/present) A terminal-based presentation tool with markdown support (more focused on general presentations, less on code tutorials) also the last commit was in 2020.
## 🐛 Troubleshooting
**Q: The colors don't show up correctly in my terminal.**
A: Make sure your terminal supports true color and has a compatible color scheme.
**Q: The tutorial doesn't respond to keyboard input.**
A: Verify that your terminal emulator is properly forwarding keyboard events.