presenterm/examples/README.md
2024-02-20 11:33:44 -08:00

43 lines
1.4 KiB
Markdown

Examples
===
This section contains a few example presentations that display different features and styles you can use in your own. In
order to run the presentations locally, first [install
presenterm](https://mfontanini.github.io/presenterm/guides/installation.html), clone this repo, and finally run:
```shell
presenterm examples/<name-of-the-presentation>.md
```
# Demo
[Source](/examples/demo.md)
This is the main demo presentation, which showcases most features and uses the default dark theme.
This is how it looks like when rendered:
![](/docs/src/assets/demo.gif)
# Code
[Source](/examples/code.md)
This example contains some piece of code and showcases some different styling properties to make it look a bit different
than how it looks like by default by using:
* Use left alignment for code blocks.
* No background for code blocks.
[![asciicast](https://asciinema.org/a/irNPKwEkPZzFbQP6jIKfVL30b.svg)](https://asciinema.org/a/irNPKwEkPZzFbQP6jIKfVL30b)
# Footer
[Source](/examples/footer.md)
This example uses a template-style footer, which lets you place some text on the left, center, and right of every slide.
A few template variables, such as `current_slide` and `total_slides` can be used to reference properties of the
presentation.
[![asciicast](https://asciinema.org/a/DLpBDpCbEp5pSrNZ2Vh4mmIY1.svg)](https://asciinema.org/a/DLpBDpCbEp5pSrNZ2Vh4mmIY1)