mirror of
https://github.com/mfontanini/presenterm.git
synced 2025-05-05 15:32:58 +00:00
54bddaf017
Some checks failed
Deploy docs / build-and-deploy (push) Has been cancelled
Merge checks / Checks (push) Has been cancelled
Merge checks / Validate nix flake (push) Has been cancelled
Merge checks / Validate bat assets (push) Has been cancelled
Merge checks / Validate JSON schemas (push) Has been cancelled
This adds new optional `start_line` and `end_line` properties when using a `file` type snippet, which allow specifying the line range to be used. Caveats: * The line selection is applied before highlighting so if you truncate the file in a place that should be highlighted in some way because of something that came before (e.g. multi line comments) it won't be highlighted appropriately. This can be fixed but requires changing a few things and I think this should not be hit very often. * Using `+line_numbers` will always start at 1. In the future I may add a property like `preserve_line_numbers` but again this would require changing a few things (the same ones as the point above) so I kept it this way for now. Example: ~~~markdown ```file +line_numbers language: rust path: scripts/foo.rs start_line: 3 end_line: 20 ``` ~~~ Closes #562
presenterm
presenterm lets you create presentations in markdown format and run them from your terminal, with support for image and animated gifs, highly customizable themes, code highlighting, exporting presentations into PDF format, and plenty of other features. This is how the demo presentation looks like when running in the kitty terminal:
Check the rest of the example presentations in the examples directory.
Documentation
Visit the documentation to get started.
Features
- Define your presentation in a single markdown file.
- Images and animated gifs on terminals like kitty, iterm2, and wezterm.
- Customizable themes including colors, margins, layout (left/center aligned content), footer for every slide, etc. Several built-in themes can give your presentation the look you want without having to define your own.
- Code highlighting for a wide list of programming languages.
- Font sizes for terminals that support them.
- Selective/dynamic code highlighting that only highlights portions of code at a time.
- Column layouts.
- mermaid graph rendering.
- LaTeX and typst formula rendering.
- Introduction slide that displays the presentation title and your name.
- Slide titles.
- Snippet execution for various programming languages.
- Export presentations to PDF.
- Pause portions of your slides.
- Custom key bindings.
- Automatically reload your presentation every time it changes for a fast development loop.
- Define speaker notes to aid you during presentations.
See the introduction page to learn more.
Presenterm in Action
Here are some talks and demos that feature presenterm:
- Bringing Terminal Aesthetics to the Web With Rust by Orhun Parmaksız
- 7 Rust Terminal Tools That You Should Use by Orhun Parmaksız
- Renaissance of Terminal User Interfaces with Rust by Orhun Parmaksız
Gave a talk using presenterm? We would love to feature it here! Open a PR or issue to get it added.