presenterm
===
**_presenterm_ lets you create presentations in markdown format and render them in your terminal.**
This is how the [demo presentation](examples/demo.md) looks like:
# Documentation
Visit the [documentation][guide-introduction] to get started.
# Features
* Define your presentation in a single markdown file.
* [Image rendering support][guide-images] for _iterm2_, terminals that support the _kitty_ graphics protocol, and
_sixel_.
* [Customize your presentation's look][guide-themes] by defining themes, including colors, margins, layout (left/center
aligned content), footer for every slide, etc.
* Code highlighting for a [wide list of programming languages][guide-code-highlight].
* [Selective/dynamic][guide-selective-highlight] code highlighting such that only a subset of the lines are highlighted
at a time, and different sets of lines are highlighted as you move your slides forward.
* Configurable [column layouts][guide-layout] that let you structure parts of your slide into columns.
* Support for [_LaTeX_ and _typst_ code block rendering][guide-latex] so you can define formulas as text and have them
automatically render as images when rendering a presentation.
* Support for an [introduction slide][guide-intro-slide] that displays the presentation title and your name.
* Support for [slide titles][guide-slide-titles].
* Support for [shell code execution][guide-code-execute].
* Support for [generating PDF files][guide-pdf-export] from presentations to share with other people.
* Support for [pauses][guide-pauses] in between each slide so that it progressively renders for a more interactive
presentation.
* Automatically reload your presentation every time it changes for a fast development loop.
* [Terminal colored themes][guide-builtin-themes] that use your terminal's color scheme. This means if your terminal uses
transparent backgrounds or images as background, those will be implicitly set as the background of your presentation.
See the [introduction page][guide-basics] to learn more.
## Images
Images are supported if you're using iterm2, a terminal the supports the kitty graphics protocol (such as
[kitty](https://sw.kovidgoyal.net/kitty/), of course), or one that supports sixel.
Read more about images [here][guide-images].
## Hot reload
Unless you run in presentation mode by passing in the `--present` parameter, _presenterm_ will automatically reload your
presentation file every time you save it. _presenterm_ will also automatically detect which specific slide was modified
and jump to it so you don't have to be jumping back and forth between the source markdown and the presentation to see
how the changes look like.
[](https://asciinema.org/a/UTestkjb8M8K2mQgf9rDmzDGA)
## Column layouts
Column layouts allow you to organize content into columns. You can define 2 or more columns, choose how wide you want
them to be, and then put any content into them. For example:
See the [guide on layouts][guide-layout] to learn more.
## Shell code execution
Any shell code can be marked for execution, making _presenterm_ execute it and render its output when you press ctrl+e.
In order to do this, annotate the code block with `+exec` (e.g. `bash +exec`). **Obviously use this at your own risk!**
[](https://asciinema.org/a/1v3IqCEtU9tqDjVj78Pp7SSe2)
See more details on this [here][guide-code-execute].
# Acknowledgements
This tool is heavily inspired by:
* [slides](https://github.com/maaslalani/slides/)
* [lookatme](https://github.com/d0c-s4vage/lookatme).
* [sli.dev](https://sli.dev/).
Support for code highlighting on many languages is thanks to [bat](https://github.com/sharkdp/bat), which contains a
custom set of syntaxes that extend [syntect](https://github.com/trishume/syntect)'s default set of supported languages.
Run `presenterm --acknowledgements` to get a full list of all the licenses for the binary files being pulled in.
[guide-introduction]: https://mfontanini.github.io/presenterm/
[guide-installation]: https://mfontanini.github.io/presenterm/guides/installation.html
[guide-basics]: https://mfontanini.github.io/presenterm/guides/basics.html
[guide-intro-slide]: https://mfontanini.github.io/presenterm/guides/basics.html#introduction-slide
[guide-slide-titles]: https://mfontanini.github.io/presenterm/guides/basics.html#slide-titles
[guide-pauses]: https://mfontanini.github.io/presenterm/guides/basics.html#pauses
[guide-images]: https://mfontanini.github.io/presenterm/guides/basics.html#images
[guide-themes]: https://mfontanini.github.io/presenterm/guides/themes.html
[guide-builtin-themes]: https://mfontanini.github.io/presenterm/guides/themes.html#built-in-themes
[guide-code-highlight]: https://mfontanini.github.io/presenterm/guides/code-highlight.html
[guide-code-execute]: https://mfontanini.github.io/presenterm/guides/code-highlight.html#executing-code
[guide-selective-highlight]: https://mfontanini.github.io/presenterm/guides/code-highlight.html#selective-highlighting
[guide-layout]: https://mfontanini.github.io/presenterm/guides/layout.html
[guide-latex]: https://mfontanini.github.io/presenterm/guides/latex.html
[guide-pdf-export]: https://mfontanini.github.io/presenterm/guides/pdf-export.html