Presenterm

https://mfontanini.github.io/presenterm
Admin
Presenterm is a terminal-based presentation tool that lets you create and run presentations in...
Tokens:25,201
Snippets:470
Trust Score:9.7
Update:5 months ago
Show doc for...
Tokens:
Raw
### Install presenterm with cargo-binstall

Source: https://mfontanini.github.io/presenterm/install.html

Use cargo-binstall for a quick installation if you are already a user of this tool.

```bash
cargo binstall presenterm
```

--------------------------------

### Install presenterm-bin with AUR helper

Source: https://mfontanini.github.io/presenterm/install.html

Install the pre-built binaries of presenterm using an AUR helper like paru or yay.

```bash
paru/yay -S presenterm-bin
```

--------------------------------

### Install presenterm with Scoop

Source: https://mfontanini.github.io/presenterm/install.html

Install presenterm using the Scoop package manager on Windows.

```bash
scoop install main/presenterm
```

--------------------------------

### Install presenterm with WinGet

Source: https://mfontanini.github.io/presenterm/install.html

Install presenterm using the Windows Package Manager (WinGet).

```bash
winget install --id=mfontanini.presenterm  -e
```

--------------------------------

### Install presenterm-git with AUR helper

Source: https://mfontanini.github.io/presenterm/install.html

Install the git version of presenterm using an AUR helper like paru or yay.

```bash
paru/yay -S presenterm-git
```

--------------------------------

### Install presenterm with cargo install

Source: https://mfontanini.github.io/presenterm/install.html

Install presenterm using cargo, ensuring the locked version for stability.

```bash
cargo install --locked presenterm
```

--------------------------------

### Start Presenterm with Speaker Notes

Source: https://mfontanini.github.io/presenterm/features/speaker-notes.html

Use the `--publish-speaker-notes` flag to start the main presentation instance and `--listen-speaker-notes` for the speaker notes display instance. These commands are run in separate shells.

```bash
# Start the main instance
presenterm demo.md --publish-speaker-notes

# In another shell: start the speaker notes instance
presenterm demo.md --listen-speaker-notes
```

--------------------------------

### Install presenterm with pacman

Source: https://mfontanini.github.io/presenterm/install.html

Install presenterm from the official repositories using the pacman package manager on Arch Linux-based systems.

```bash
pacman -S presenterm
```

--------------------------------

### Install presenterm with Nix

Source: https://mfontanini.github.io/presenterm/install.html

Install presenterm using the Nix package manager. Use the appropriate command for NixOS or other Nix environments.

```bash
nix-env -iA nixos.presenterm    # for nixos
nix-env -iA nixpkgs.presenterm  # for non-nixos
```

--------------------------------

### Clone and Run Demo Presentation

Source: https://mfontanini.github.io/presenterm/features/introduction.html

Clone the presenterm repository and run the demo presentation. Ensure you have presenterm installed first.

```bash
git clone https://github.com/mfontanini/presenterm.git
cd presenterm
presenterm examples/demo.md
```

--------------------------------

### Start Main Instance for Speaker Notes

Source: https://mfontanini.github.io/presenterm/print.html

Initiate the primary Presenterm instance with the `--publish-speaker-notes` flag to enable speaker notes functionality during a presentation.

```bash
__
# Start the main instance
presenterm demo.md --publish-speaker-notes

```

--------------------------------

### Install presenterm on macOS with brew

Source: https://mfontanini.github.io/presenterm/install.html

Install the latest stable version of presenterm using the Homebrew package manager on macOS.

```bash
brew install presenterm
```

--------------------------------

### Install latest unreleased presenterm from source

Source: https://mfontanini.github.io/presenterm/install.html

Build and install the latest unreleased version of presenterm directly from its GitHub repository using cargo.

```bash
cargo install --locked --git https://github.com/mfontanini/presenterm
```

--------------------------------

### Start Speaker Notes Listener

Source: https://mfontanini.github.io/presenterm/print.html

Starts a presenterm instance to listen for speaker notes. This is typically run in a separate shell.

```bash
presenterm demo.md --listen-speaker-notes
```

--------------------------------

### Layout Example

Source: https://mfontanini.github.io/presenterm/features/layout.html

An example demonstrating the use of `column_layout`, `column`, and `reset_layout` to structure a slide with code, an image, and text below the columns.

```markdown
Layout example
==============

<!-- column_layout: [2, 1] -->

<!-- column: 0 -->

This is some code I like:

```rust
fn potato() -> u32 {
    42
}
```

Things I like about it:
1. Potato
2. Rust
3. The image on the right

<!-- column: 1 -->

![](examples/doge.png)

_Picture by Alexis Bailey / CC BY-NC 4.0_

<!-- reset_layout -->

Because we just reset the layout, this text is now below both of the columns.
```

--------------------------------

### Install latest unreleased presenterm with brew

Source: https://mfontanini.github.io/presenterm/install.html

Build and install the latest development version of presenterm on macOS using Homebrew's --head flag.

```bash
brew install --head presenterm
```

--------------------------------

### Front Matter for Intro Slide

Source: https://mfontanini.github.io/presenterm/features/themes/definition.html

Example of front matter to enable a custom introductory slide with title, subtitle, and author.

```yaml
---
title: Presenting from my terminal
sub_title: Like it's 1990
author: John Doe
---
```

--------------------------------

### Export Presentation to PDF

Source: https://mfontanini.github.io/presenterm/print.html

Convert a Presenterm markdown file to a PDF using the `presenterm --export-pdf` command. Ensure `weasyprint` is installed.

```bash
__
presenterm --export-pdf examples/demo.md

```

--------------------------------

### Execute Rust Code Snippet

Source: https://mfontanini.github.io/presenterm/features/code/execution.html

Demonstrates a basic Rust program execution. Lines starting with '//' are hidden from the presentation but executed.

```rust
# //! time = "0.1.25"
# // The lines above will be hidden
fn main() {
    println!("the time is {}", time::now().rfc822z());
}

```

--------------------------------

### Render Mermaid Diagrams Automatically

Source: https://mfontanini.github.io/presenterm/features/code/mermaid.html

Use the `mermaid` language tag with `+render` to automatically convert mermaid diagrams into images. Requires `mermaid-cli` to be installed.

```mermaid
sequenceDiagram
    Mark --> Bob: Hello!
    Bob --> Mark: Oh, hi mark!
```

--------------------------------

### Render D2 Diagrams

Source: https://mfontanini.github.io/presenterm/features/code/d2.html

D2 snippets tagged with `d2` and using a `+render` attribute are automatically converted into images. This requires having D2 installed.

```d2
```d2 +render
my_table: {
  shape: sql_table
  id: int {constraint: primary_key}
  last_updated: timestamp with time zone
}
```
```

--------------------------------

### Render D2 Diagram with +render Attribute

Source: https://mfontanini.github.io/presenterm/print.html

Use the `+render` attribute with D2 language snippets to automatically convert them into images. Ensure D2 is installed. Scale can be adjusted with `+width` or `d2.scale` config.

```d2
d2 +render
my_table: {
  shape: sql_table
  id: int {constraint: primary_key}
  last_updated: timestamp with time zone
}
```

--------------------------------

### Validate Snippets During Development

Source: https://mfontanini.github.io/presenterm/features/code/execution.html

Use the `--validate-snippets` flag to automatically run and validate all `+exec`, `+exec_replace`, and `+validate` snippets on presentation start. Errors are reported if snippets return non-zero exit codes. Snippets are re-run on reload.

```rust
fn main() {
    let q = 42;
    let w = q + "foo"; // oops
}
```

--------------------------------

### Render LaTeX Code Block

Source: https://mfontanini.github.io/presenterm/features/code/latex.html

Use the `+render` attribute on a LaTeX code block to have it automatically rendered as an image during presentation loading. This requires Typst and Pandoc to be installed.

```latex
\[ \sum_{n=1}^{\infty} 2^{-n} = 1 \]
```

--------------------------------

### Run presenterm with Nix flakes

Source: https://mfontanini.github.io/presenterm/install.html

Execute presenterm directly using Nix flakes, either from the main nixpkgs channel or the GitHub repository.

```bash
nix run nixpkgs#presenterm            # to run from nixpkgs
nix run github:mfontanini/presenterm  # to run from github repo
```

--------------------------------

### Export Presentation to PDF with uv

Source: https://mfontanini.github.io/presenterm/print.html

Use `uv run --with weasyprint` to execute the PDF export command, ensuring `weasyprint` is available in the environment.

```bash
__
uv run --with weasyprint presenterm --export-pdf examples/demo.md

```

--------------------------------

### Intro Slide Customization

Source: https://mfontanini.github.io/presenterm/features/themes/definition.html

Configures alignment and colors for the intro slide title and author.

```yaml
intro_slide:
  title:
    alignment: left
    margin:
      percent: 8
  author:
    colors:
      foreground: black
    positioning: below_title
```

--------------------------------

### Execute Rust Code with Hidden Lines

Source: https://mfontanini.github.io/presenterm/features/code/execution.html

Executes a Rust snippet where lines starting with '# ' are hidden from the presentation but still run. This is useful for hiding boilerplate code.

```rust
# fn main() {
println!("Hello world!");
# }

```

--------------------------------

### List Available Built-in Themes

Source: https://mfontanini.github.io/presenterm/features/themes/introduction.html

Execute the '--list-themes' command-line argument to display all available built-in themes. This command runs a presentation rendering each slide with a different theme.

```bash
presenterm --list-themes

```

--------------------------------

### Configure Default Key Bindings

Source: https://mfontanini.github.io/presenterm/configuration/settings.html

Manually configure key bindings in the config file via the `bindings` key. These are the default settings.

```yaml
bindings:
  # the keys that cause the presentation to move forwards.
  next: ["l", "j", "<right>", "<page_down>", "<down>", " "]

  # the keys that cause the presentation to move backwards.
  previous: ["h", "k", "<left>", "<page_up>", "<up>"]

  # the keys that cause the presentation to move "fast" to the next slide. this will ignore:
  #
  # * Pauses.
  # * Dynamic code highlights.
  # * Slide transitions, if enabled.
  next_fast: ["n"]

  # same as `next_fast` but jumps fast to the previous slide.
  previous_fast: ["p"]

  # the key binding to jump to the first slide.
  first_slide: ["gg"]

  # the key binding to jump to the last slide.
  last_slide: ["G"]

  # the key binding to jump to a specific slide.
  go_to_slide: ["<number>G"]

  # the key binding to execute a piece of shell code.
  execute_code: ["<c-e>"]

  # the key binding to reload the presentation.
  reload: ["<c-r>"]

  # the key binding to toggle the slide index modal.
  toggle_slide_index: ["<c-p>"] 

  # the key binding to toggle the key bindings modal.
  toggle_bindings: ["?"] 

  # the key binding to close the currently open modal.
  close_modal: ["<esc>"]

  # the key binding to close the application.
  exit: ["<c-c>", "q"]

  # the key binding to suspend the application.
  suspend: ["<c-z>"]
```

--------------------------------

### All Available Comment Commands

Source: https://mfontanini.github.io/presenterm/print.html

A comprehensive list of all comment commands supported by presenterm, including their default values where applicable.

```markdown
<!-- pause -->
<!-- end_slide -->
<!-- new_line -->
<!-- new_lines: 2 -->
<!-- jump_to_middle -->
<!-- column_layout: [1, 2] -->
<!-- column: 0 -->
<!-- reset_layout -->
<!-- incremental_lists: true -->
<!-- incremental_lists: false -->
<!-- no_footer -->
<!-- font_size: 2 -->
<!-- alignment: left -->
<!-- alignment: center -->
<!-- alignment: right -->
<!-- skip_slide -->
<!-- list_item_newlines: 2 -->
<!-- include: file.md -->
<!-- speaker_note: Your note here -->
<!-- snippet_output: identifier -->
```

--------------------------------

### Intro Slide Front Matter

Source: https://mfontanini.github.io/presenterm/print.html

Specifies the title, subtitle, and author for the introductory slide using front matter.

```yaml
__
---
title: Presenting from my terminal
sub_title: Like it's 1990
author: John Doe
---

```

--------------------------------

### Export Presentation to PDF

Source: https://mfontanini.github.io/presenterm/features/exports.html

Use the `--export-pdf` flag to convert your presentation markdown file into a PDF. The output file will be named after the input file with a .pdf extension in the same directory. You can specify a different output path using the `--output` flag.

```bash
presenterm --export-pdf examples/demo.md
```

```bash
uv run --with weasyprint presenterm --export-pdf examples/demo.md
```

--------------------------------

### Image Footer Configuration

Source: https://mfontanini.github.io/presenterm/features/themes/definition.html

Configure a footer with images for left, center, and right positions. Adjust the height to control image size.

```yaml
__
footer:
  style: template
  left:
    image: potato.png
  center:
    image: banana.png
  right:
    image: apple.png
  # The height of the footer to adjust image sizes
  height: 5

```

--------------------------------

### List Presenterm Comment Commands

Source: https://mfontanini.github.io/presenterm/features/commands.html

This command lists all available comment commands for Presenterm. It's useful for understanding the full range of comment functionalities.

```bash
presenterm --list-comment-commands
```

--------------------------------

### Configure YAML Language Server Schema

Source: https://mfontanini.github.io/presenterm/print.html

Include this line at the beginning of your `config.yaml` file to enable autocompletion and documentation for the configuration schema in your editor.

```yaml
# yaml-language-server: $schema=https://raw.githubusercontent.com/mfontanini/presenterm/master/config-file-schema.json
```

--------------------------------

### Export Presentation to HTML

Source: https://mfontanini.github.io/presenterm/print.html

Generate a single, self-contained HTML file from a Presenterm markdown file using the `presenterm --export-html` command. This requires no extra dependencies.

```bash
__
presenterm --export-html examples/demo.md

```

--------------------------------

### Enable Executable Code Block

Source: https://mfontanini.github.io/presenterm/features/code/execution.html

Add the `+exec` attribute to a code block to make it executable. Press `control+e` to run the code and display its output below the snippet. Execution is stateful across slides.

```bash
echo hello world
```

--------------------------------

### Progress Bar Footer Configuration

Source: https://mfontanini.github.io/presenterm/features/themes/definition.html

Enable a progress bar footer. Optionally customize the character used to draw the bar.

```yaml
__
footer:
  style: progress_bar

  # Optional!
  character: 🚀

```

--------------------------------

### Configure Image Size Prefix

Source: https://mfontanini.github.io/presenterm/configuration/options.html

Customize the prefix used for image size attributes, allowing for shorter syntax like `![width:50%](path.png)`.

```yaml
---
options:
  image_attributes_prefix: ""
---

![width:50%](path.png)

```

--------------------------------

### Add presenterm to NixOS system packages

Source: https://mfontanini.github.io/presenterm/install.html

Configure NixOS to include presenterm in the system's packages by adding it to your configuration.nix.

```nix
environment.systemPackages = [
  pkgs.presenterm
];
```

--------------------------------

### Set Light and Dark Themes

Source: https://mfontanini.github.io/presenterm/print.html

Configure separate light and dark themes. Presenterm will automatically detect the terminal's theme on launch and select the appropriate presentation theme.

```yaml
__
defaults:
  theme:
    light: light
    dark: dark

```

--------------------------------

### Set Default Theme

Source: https://mfontanini.github.io/presenterm/configuration/settings.html

Configure the default theme for all presentations. If a presentation does not explicitly set a theme, this will be used.

```yaml
defaults:
  theme: light
```

--------------------------------

### Set Light/Dark Themes via Front Matter

Source: https://mfontanini.github.io/presenterm/print.html

Configure separate themes for light and dark terminal color schemes using `theme.light` and `theme.dark` in the front matter. This allows for adaptive theming.

```yaml
---
theme:
  # The theme used if your terminal is using light colors.
  light: light

  # The theme used if your terminal is using dark colors.
  dark: dark
---
```

--------------------------------

### Header Styling (H1 and H2)

Source: https://mfontanini.github.io/presenterm/features/themes/definition.html

Configure styles for different header levels (h1, h2, etc.), including prefixes, colors, bold, underline, and italics.

```yaml
__
headings:
  # H1 style.
  h1:
    # The prefix to use for the heading
    prefix: "██"

    # The colors to use.
    colors:
      foreground: beeeff
      background: feeedd
    # Whether to style for the title using bold text.
    bold: true

    # Whether to style for the title using underlined text.
    underlined: true

    # Whether to style for the title using italics text.
    italics: true
  
  # H2 style, same as the keys for H1.
  h2:
    prefix: "▓▓▓"
    colors:
      foreground: feeedd

```

--------------------------------

### Configure Code Execution

Source: https://mfontanini.github.io/presenterm/features/code/execution.html

Code execution must be explicitly enabled either via the `-x` command line parameter or by setting `snippet.exec.enable` to `true` in the config file.

--------------------------------

### Configure Theme for Rendered Images

Source: https://mfontanini.github.io/presenterm/features/code/latex.html

Define the background and foreground colors, as well as horizontal and vertical margins for rendered images within your Presenterm theme configuration.

```yaml
typst:
  colors:
    background: ff0000
    foreground: 00ff00

  # In points
  horizontal_margin: 2
  vertical_margin: 2
```

--------------------------------

### Vim Configuration for Comment Commands

Source: https://mfontanini.github.io/presenterm/print.html

Integrate presenterm comment command selection into Vim using fzf.vim. Press Ctrl+K in insert mode to open a picker.

```vimscript
" Presenterm comment command helper
if executable('presenterm') && executable('fzf')
  inoremap <expr> <c-k> fzf#vim#complete(fzf#wrap({
        \ 'source':  'presenterm --list-comment-commands',
        \ 'options': '--header "Comment Command Selection" --no-hscroll',
        \ 'reducer': { lines -> lines[0] } }))
endif
```

--------------------------------

### Default Theme Styles

Source: https://mfontanini.github.io/presenterm/features/themes/definition.html

Specifies default margin and colors for all slides.

```yaml
default:
  margin:
    percent: 8
  colors:
    foreground: "e6e6e6"
    background: "040312"
```

--------------------------------

### Set Independent Light and Dark Themes

Source: https://mfontanini.github.io/presenterm/configuration/settings.html

Configure separate light and dark themes. Presenterm will automatically detect the terminal's foreground and background colors to select the appropriate theme.

```yaml
defaults:
  theme:
    light: light
    dark: dark
```

--------------------------------

### Set Presentation Metadata with Front Matter

Source: https://mfontanini.github.io/presenterm/features/introduction.html

Configure presentation title, subtitle, and author using YAML front matter at the beginning of your markdown file to generate an introduction slide.

```yaml
---
title: "My _first_ **presentation**"
sub_title: (in presenterm!)
author: Myself
---
```

--------------------------------

### Configure PPI for Rendered Images

Source: https://mfontanini.github.io/presenterm/features/code/latex.html

Set the Pixels Per Inch (PPI) for generated images in Presenterm's configuration file. Higher PPI results in larger images. The default is 300 PPI.

```yaml
typst:
  ppi: 400
```

--------------------------------

### Vim Configuration for Presenterm Comment Commands

Source: https://mfontanini.github.io/presenterm/features/commands.html

Integrates Presenterm comment command selection into Vim using fzf.vim. Press Ctrl+K in insert mode to open a picker for comment commands.

```vim
" Presenterm comment command helper
if executable('presenterm') && executable('fzf')
  inoremap <expr> <c-k> fzf#vim#complete(fzf#wrap({
        \ 'source':  'presenterm --list-comment-commands',
        \ 'options': '--header "Comment Command Selection" --no-hscroll',
        \ 'reducer': { lines -> lines[0] } }))
endif

```

--------------------------------

### Configure Slide Transition Animation

Source: https://mfontanini.github.io/presenterm/configuration/settings.html

Set the duration, frame count, and animation style for slide transitions. Replace `<style_name>` with a supported animation style.

```yaml
transition:
  # how long the transition should last.
  duration_millis: 750

  # how many frames should be rendered during the transition
  frames: 45

  # the animation to use
  animation:
    style: <style_name>
```

--------------------------------

### Mermaid Graph Customization

Source: https://mfontanini.github.io/presenterm/features/themes/definition.html

Configure the background color and theme for mermaid graphs rendered by presenterm.

```yaml
__
mermaid:
  background: transparent
  theme: dark

```

--------------------------------

### Export Presentation to HTML

Source: https://mfontanini.github.io/presenterm/features/exports.html

Use the `--export-html` flag to generate a single, self-contained HTML file of your presentation. This format embeds all images and styles, requiring no extra dependencies. The output file will be named after the input file with an .html extension. The `--output` flag can be used to specify a custom output location.

```bash
presenterm --export-html examples/demo.md
```

--------------------------------

### Execute Bash Command to Display Image

Source: https://mfontanini.github.io/presenterm/features/code/execution.html

Uses the +image attribute to execute a bash command and render its output as an image. The output must be in JPG or PNG format.

```bash
cat examples/doge.png
```

--------------------------------

### Configure Command Prefix

Source: https://mfontanini.github.io/presenterm/configuration/options.html

Set a custom prefix for HTML comments to be recognized as commands, preventing regular comments from being misinterpreted.

```yaml
---
options:
  command_prefix: "cmd:"
---

<!-- remember to say "potato here" -->

Tasty vegetables
================

* Potato

<!-- cmd:pause -->

**That's it!**

```

--------------------------------

### Set Maximum Presentation Width

Source: https://mfontanini.github.io/presenterm/print.html

Configure the maximum number of columns the presentation will stretch to. If the terminal is wider, the presentation will be centered.

```yaml
__
defaults:
  max_columns: 100

```

--------------------------------

### Enable Incremental List Rendering

Source: https://mfontanini.github.io/presenterm/configuration/options.html

Make all bullet points in lists appear with pauses in between them.

```yaml
---
options:
  incremental_lists: true
---

* pauses
* in
* between

```

--------------------------------

### Enable Global Snippet Execution

Source: https://mfontanini.github.io/presenterm/configuration/settings.html

Enable snippet execution globally for all presentations by setting `snippet.exec.enable` to `true`. Use this at your own risk.

```yaml
snippet:
  exec:
    enable: true
```

--------------------------------

### Default Margin and Colors

Source: https://mfontanini.github.io/presenterm/print.html

Configures the default presentation style with an 8% margin on all slides and sets default foreground to 'e6e6e6' and background to '040312'.

```yaml
__
default:
  margin:
    percent: 8
  colors:
    foreground: "e6e6e6"
    background: "040312"

```

--------------------------------

### Execute LS with Color Output

Source: https://mfontanini.github.io/presenterm/print.html

Snippets with escape codes for color or styling will be displayed with those styles. Force tools to use colored output if they don't by default.

```bash
ls /tmp --color=always

```

--------------------------------

### Configure Slide Transition Duration and Frames

Source: https://mfontanini.github.io/presenterm/print.html

Set the duration in milliseconds and the number of frames for slide transitions. The `style` property should be set to a supported animation style.

```yaml
__
transition:
  # how long the transition should last.
  duration_millis: 750

  # how many frames should be rendered during the transition
  frames: 45

  # the animation to use
  animation:
    style: <style_name>

```

--------------------------------

### Default Key Bindings Configuration

Source: https://mfontanini.github.io/presenterm/print.html

Defines the default key bindings for navigation, fast movement, and various actions like reloading, executing code, and exiting.

```yaml
__
bindings:
  # the keys that cause the presentation to move forwards.
  next: ["l", "j", "<right>", "<page_down>", "<down>", " "]

  # the keys that cause the presentation to move backwards.
  previous: ["h", "k", "<left>", "<page_up>", "<up>"]

  # the keys that cause the presentation to move "fast" to the next slide. this will ignore:
  #
  # * Pauses.
  # * Dynamic code highlights.
  # * Slide transitions, if enabled.
  next_fast: ["n"]

  # same as `next_fast` but jumps fast to the previous slide.
  previous_fast: ["p"]

  # the key binding to jump to the first slide.
  first_slide: ["gg"]

  # the key binding to jump to the last slide.
  last_slide: ["G"]

  # the key binding to jump to a specific slide.
  go_to_slide: ["<number>G"]

  # the key binding to execute a piece of shell code.
  execute_code: ["<c-e>"]

  # the key binding to reload the presentation.
  reload: ["<c-r>"]

  # the key binding to toggle the slide index modal.
  toggle_slide_index: ["<c-p>"] 

  # the key binding to toggle the key bindings modal.
  toggle_bindings: ["?"] 

  # the key binding to close the currently open modal.
  close_modal: ["<esc>"]

  # the key binding to close the application.
  exit: ["<c-c>", "q"]

  # the key binding to suspend the application.
  suspend: ["<c-z>"]


```

--------------------------------

### Dynamic Line Highlighting in Rust

Source: https://mfontanini.github.io/presenterm/features/code/highlighting.html

Create dynamic highlighting that changes with slide progression using the `|` separator to define highlighted sections for different frames. Use `all` to highlight all lines for a frame.

```rust
   fn potato() -> u32 {

       println!("Hello world");
       let mut q = 42;
       q = q * 1337;
       q
   }
```

--------------------------------

### Template Footer Configuration

Source: https://mfontanini.github.io/presenterm/features/themes/definition.html

Defines a template footer with dynamic content and custom height.

```yaml
footer:
  style: template
  left: "My **name** is {author}"
  center: "_@myhandle_"
  right: "{current_slide} / {total_slides}"
  height: 3
```

--------------------------------

### Configure Export Snippet Execution

Source: https://mfontanini.github.io/presenterm/configuration/settings.html

Set to 'sequential' to execute snippets one after another. By default, snippets are executed in parallel for faster exports.

```yaml
export:
  snippets: sequential
```

--------------------------------

### Enter a Column

Source: https://mfontanini.github.io/presenterm/features/layout.html

Use the `column` HTML comment followed by the column index (0-based) to direct markdown content into a specific column.

```html
<!-- column: 0 -->
```

--------------------------------

### Specify Custom Theme File via Front Matter

Source: https://mfontanini.github.io/presenterm/features/themes/introduction.html

Reference a custom theme file located on your filesystem using the 'theme.path' property in the front matter. This allows for the use of user-created themes.

```yaml
---
theme:
  path: /home/me/Documents/epic-theme.yaml
---

```

--------------------------------

### Extend Existing Themes

Source: https://mfontanini.github.io/presenterm/features/themes/definition.html

Create custom themes by extending built-in or other custom themes. This allows inheriting properties and overriding specific elements like the background color.

```yaml
__
extends: dark
default:
  colors:
    background: "000000"

```

--------------------------------

### Include External Markdown

Source: https://mfontanini.github.io/presenterm/features/commands.html

Use the `include` command to embed content from an external markdown file. Paths for included files are relative to the included file's location.

```markdown
<!-- include: foo.md -->
```

--------------------------------

### Set Maximum Presentation Width and Alignment

Source: https://mfontanini.github.io/presenterm/print.html

Configure the maximum number of columns and alignment (left, center, right) for wide terminals.

```yaml
__
defaults:
  max_columns: 100
  # Valid values: left, center, right
  max_columns_alignment: left

```

--------------------------------

### Execute Python Script with Bat Highlighting

Source: https://mfontanini.github.io/presenterm/features/code/highlighting.html

Execute a Python script using `bat` for highlighting. The `+exec_replace` flag is used here, and the output of the command will replace the snippet. Ensure code execution is enabled in your configuration.

```bash
bat --color always script.py
```

--------------------------------

### Configure Custom Mermaid Config File

Source: https://mfontanini.github.io/presenterm/configuration/settings.html

Specify a custom mermaid config file to set appropriate configurations, such as the font family.

```yaml
mermaid:
  config_file: /home/foo/my_config_file.yml
```

--------------------------------

### Enable Global Snippet Execution and Replace

Source: https://mfontanini.github.io/presenterm/configuration/settings.html

Enable snippet execution and replace globally by setting `snippet.exec_replace.enable` to `true`. Use this at your own risk, as it executes code without user intervention.

```yaml
snippet:
  exec_replace:
    enable: true
```

--------------------------------

### Define GitHub Style Markdown Alerts

Source: https://mfontanini.github.io/presenterm/features/themes/definition.html

Configure the 'alert' key to customize the appearance of GitHub-style markdown alerts, including base colors, prefixes, and styles for different alert types.

```yaml
__
alert:
  # the base colors used in all text in an alert
  base_colors:
    foreground: red
    background: black

  # the prefix used in every line in the alert
  prefix: "▍ "

  # the style for each alert type
  styles:
    note:
      color: blue
      title: Note
      icon: I
    tip:
      color: green
      title: Tip
      icon: T
    important:
      color: cyan
      title: Important
      icon: I
    warning:
      color: orange
      title: Warning
      icon: W
    caution:
      color: red
      title: Caution
      icon: C

```

--------------------------------

### Configure Export Pauses

Source: https://mfontanini.github.io/presenterm/configuration/settings.html

Set to 'new_slide' to make each pause in the presentation generate a new page in PDF exports. Pauses are ignored by default.

```yaml
export:
  pauses: new_slide
```

--------------------------------

### Reference Custom Theme File via Front Matter

Source: https://mfontanini.github.io/presenterm/print.html

Use the `theme.path` property in the front matter to specify a custom theme file located on your filesystem. This allows for complex, user-defined themes.

```yaml
---
theme:
  path: /home/me/Documents/epic-theme.yaml
---
```

--------------------------------

### Specify Light/Dark Themes via Front Matter

Source: https://mfontanini.github.io/presenterm/features/themes/introduction.html

Define separate themes for light and dark terminal color schemes using 'theme.light' and 'theme.dark' in the front matter. This allows for adaptive theming based on the user's terminal settings.

```yaml
---
theme:
  light: light
  dark: dark
---

```

--------------------------------

### Intro Slide Title and Author Styling

Source: https://mfontanini.github.io/presenterm/print.html

Customizes the intro slide by setting the title alignment to left with an 8% margin and the author's text color to black, positioned below the title.

```yaml
__
intro_slide:
  title:
    alignment: left
    margin:
      percent: 8
  author:
    colors:
      foreground: black
    positioning: below_title

```

--------------------------------

### Render Image from Bash Snippet

Source: https://mfontanini.github.io/presenterm/print.html

The '+image' attribute renders the output of an executable snippet as an image. The code must only emit a JPG or PNG image.

```bash
cat examples/doge.png

```

--------------------------------

### Set Maximum Presentation Rows and Alignment

Source: https://mfontanini.github.io/presenterm/configuration/settings.html

Configure the maximum number of rows and specify the vertical alignment (top, center, or bottom) for the presentation when the terminal exceeds this height.

```yaml
defaults:
  max_rows: 100
  # Valid values: top, center, bottom
  max_rows_alignment: left
```

--------------------------------

### Set Maximum Presentation Columns

Source: https://mfontanini.github.io/presenterm/configuration/settings.html

Specify the maximum number of columns the presentation should occupy. If the terminal is wider, the presentation will be centered at this width to prevent excessive stretching.

```yaml
defaults:
  max_columns: 100
```

--------------------------------

### Configure Mermaid Render Threads

Source: https://mfontanini.github.io/presenterm/configuration/settings.html

Configure the number of threads used for rendering mermaid charts asynchronously. Defaults to 2.

```yaml
snippet:
  render:
    threads: 2
```

--------------------------------

### Element Colors

Source: https://mfontanini.github.io/presenterm/features/themes/definition.html

Sets foreground and background colors for elements using hex notation.

```yaml
default:
  colors:
    foreground: ff0000
    background: 00ff00
```

--------------------------------

### Always Publish Speaker Notes Configuration

Source: https://mfontanini.github.io/presenterm/features/speaker-notes.html

Configure Presenterm to always publish speaker notes by setting `speaker_notes.always_publish` to `true` in the configuration file. This eliminates the need to use the `--publish-speaker-notes` flag.

```yaml
speaker_notes:
  always_publish: true
```

--------------------------------

### List All Comment Commands

Source: https://mfontanini.github.io/presenterm/features/commands.html

The `--list-comment-commands` CLI option outputs all available comment commands. This is useful for discoverability, editor integrations, and external validation.

```bash
# List all available comment commands
presenterm --list-comment-commands

# Use with fzf for interactive selection
presenterm --list-comment-commands | fzf

# Pipe to grep to filter specific commands
presenterm --list-comment-commands | grep alignment
```

--------------------------------

### Set Max Columns and Alignment

Source: https://mfontanini.github.io/presenterm/configuration/settings.html

Configure the maximum number of columns and specify the horizontal alignment (left, center, or right) when the terminal exceeds this width.

```yaml
defaults:
  max_columns: 100
  # Valid values: left, center, right
  max_columns_alignment: left
```

--------------------------------

### Configure Custom Puppeteer Config File

Source: https://mfontanini.github.io/presenterm/configuration/settings.html

Specify a custom puppeteer config file that will be given to puppeteer by the `mmdc` tool.

```yaml
mermaid:
  puppeteer_config_file: /home/foo/puppeteer.json
```

--------------------------------

### Execute Bash Command with Colored Output

Source: https://mfontanini.github.io/presenterm/features/code/execution.html

Executes a bash command with the --color=always flag to ensure colored output is displayed. This requires the tool to support colorization.

```bash
ls /tmp --color=always
```

--------------------------------

### Enable Incremental Lists

Source: https://mfontanini.github.io/presenterm/print.html

Configure all bullet points in lists to appear with pauses in between. This can also be controlled per-list item using the `incremental_lists` comment command.

```yaml
__
---
options:
  incremental_lists: true
---

* pauses
* in
* between
```

--------------------------------

### Basic Rust Code Block

Source: https://mfontanini.github.io/presenterm/print.html

A simple Rust function definition. This demonstrates basic code block rendering.

```rust
fn potato() -> u32 {
    42
}
```

--------------------------------

### Set Maximum Presentation Height and Alignment

Source: https://mfontanini.github.io/presenterm/print.html

Configure the maximum number of rows and alignment (top, center, bottom) for tall terminals.

```yaml
__
defaults:
  max_rows: 100
  # Valid values: top, center, bottom
  max_rows_alignment: left

```

--------------------------------

### Include Subset of External Rust File

Source: https://mfontanini.github.io/presenterm/features/code/highlighting.html

To include only a specific range of lines from an external file, use the `start_line` and `end_line` optional fields.

```file
path: snippet.rs
language: rust
# Only show lines 5-10
start_line: 5
end_line: 10
```

--------------------------------

### Center Content with Layout

Source: https://mfontanini.github.io/presenterm/features/layout.html

To center content, define a layout with a larger middle column, e.g., `[1, 3, 1]`, and place content only in that middle column.

```html
<!-- column_layout: [1, 3, 1] -->
```

--------------------------------

### Template Footer Configuration

Source: https://mfontanini.github.io/presenterm/print.html

Defines a custom footer with left, center, and right aligned text using front matter variables and specifies a height of 3 rows. Supports markdown and variable substitution.

```yaml
__
footer:
  style: template
  left: "My **name** is {author}"
  center: "_@myhandle_"
  right: "{current_slide} / {total_slides}"
  height: 3

```

--------------------------------

### YAML Language Server Schema Directive

Source: https://mfontanini.github.io/presenterm/configuration/introduction.html

Include this line at the beginning of your configuration file to enable autocompletion and documentation suggestions in compatible YAML editors.

```yaml
yaml-language-server: $schema=https://raw.githubusercontent.com/mfontanini/presenterm/master/config-file-schema.json
```

--------------------------------

### List Multiple Authors in Front Matter

Source: https://mfontanini.github.io/presenterm/features/introduction.html

When a presentation has multiple authors, use the 'authors' key in the YAML front matter instead of 'author' to list them.

```yaml
---
title: Our first presentation
authors:
  - Me
  - You
---
```

--------------------------------

### User Comments

Source: https://mfontanini.github.io/presenterm/features/commands.html

Add personal notes or documentation that will be ignored during rendering using `//` or `comment:` within HTML comments.

```markdown
<!-- // This is a user comment -->
<!-- comment: This is also a user comment which won't be rendered -->
```
Tokens:
Raw