mirror of
https://github.com/mfontanini/presenterm.git
synced 2025-05-05 15:32:58 +00:00
abc132e9b5
Some checks are pending
Deploy docs / build-and-deploy (push) Waiting to run
Merge checks / Checks (push) Waiting to run
Merge checks / Validate nix flake (push) Waiting to run
Merge checks / Validate bat assets (push) Waiting to run
Merge checks / Validate JSON schemas (push) Waiting to run
This hides the JSON schema generation for the config file behind a new `json-schema` feature flag. This is not fundamental to the functioning of this tool and also there's already a schema generated [here](https://github.com/mfontanini/presenterm/blob/master/config-file-schema.json) so there's no need to have this available in the tool when released. If anyone does want the JSON schema for some specific version of the tool, they can always clone the repo and `cargo run --features json-schema`. This also removes the `serde_with` dependency and instead hand rolls the `SerializeDisplay` and `DeserializeFromStr` macros manually. These are very few lines long and doesn't make importing that crate worth it. Overall these 2 changes cause the number of crates to go down by something like 20 which is great.
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.