Slides

When presenting code, you may want to hide verbose boilerplate (like package declarations or main functions) while still allowing the code to be executable.

By prefixing lines with ///, those lines are hidden from the visual display in the slides but remain part of the code when executed via ctrl+e. Additionally, if you use the y key to yank (copy) the block, the full snippet including the /// lines will be returned.

///package main
///
import "fmt"
///
///func main() {
fmt.Println("Hello, world!")
///}

You can run commands before the slides are displayed by using a code block with three tildes (~~~). The text inside the block is passed as stdin to the command, and the block is replaced by the command's stdout.

To keep proper formatting and newlines, wrap the resulting pre-processed block in triple backticks.

Security Requirement: For security reasons, the markdown file must have execution permissions. Use chmod to enable this.

chmod +x file.md

Example usage in Markdown:

[ A ] - to -> [ B ]

If you are extending the project, the core logic is organized as follows:

• CLI Initialization & Defaults: Handled in cmd/root.go.
• Interaction (Input/Output/Controls): Managed in internal/model/model.go.
• Configuration & Metadata: Optional configurations (such as theme: dark) are processed in internal/meta/meta.go.

To make changes and verify them, run the make command. This executes the application using a default example file (go run main.go examples/slides.md).

If you are developing a new feature that depends on specific Markdown syntax, create a new test case file in the examples/ directory (e.g., examples/my-test-case.md) and run the application against that file to iterate on your changes.

To ensure your changes haven't broken existing functionality, run the test suite using make test and verify that the CLI command slides examples/slides.md still executes correctly.

# Run the application with the default example
make

# Run the test suite
make test

When running a presentation in the terminal, use the following keyboard shortcut to navigate:

• n: Move to the next slide.

Slides are authored entirely in Markdown. To define individual slides, use triple dashes --- on a separate line as a delimiter between content blocks.

Example structure:

# Slide 1
Some stuff

---

# Slide 2
Some other stuff

You can host a presentation on one machine and access it via SSH from another. This allows users to view slides without having slides installed locally.

1. On the host machine, run:

   slides serve [file]

2. On the client machine, connect to the port specified by the command:

   ssh 127.0.0.1 -p [PORT]

slides serve presentation.md

Slides supports live code execution directly within your markdown slides. You can trigger the execution of a code block by pressing ctrl+e. The output of the execution will be displayed as virtual text within the slide.

Supported languages include:

• Shells: bash, zsh, fish
• Scripting/General: elixir, go, javascript, lua, python, ruby, perl, rust, java, cpp, swift, dart, v, julia, scala

To jump to a specific slide, press /, enter your search term (interpreted as a regular expression), and press Enter.

• Use the /i flag for case-insensitive searches.
• Press ctrl+n after a search to move to the next search result.

You can customize the bottom information bar of your presentation by adding a YAML frontmatter block at the top of your slides.md file. The following keys are supported:

• author: The name of the presenter or author.
• date: The date of the presentation.
• paging: A format string for page numbering. Use %d as a placeholder for the current page and the total page count (e.g., Page %d of %d).

---
author: Gopher
date: May 22, 2022
paging: Page %d of %d
---

Slides uses standard Markdown files as the source for presentations. You can include headings (h1-h6), bulleted lists, numbered lists, tables, and code blocks. To define where one slide ends and the next begins, use triple dashes (---) on a separate line between content blocks.

# Slide 1
Some stuff

---

# Slide 2
Some other stuff

To hide the bottom information bar entirely, include the metadata block at the top of your slides.md file but set all supported fields to empty strings.

---
author: ""
date: ""
paging: ""
---