/ learning / presenterm / README.md
README.md
 1  Examples
 2  ===
 3  
 4  This section contains a few example presentations that display different features and styles you can use in your own. In 
 5  order to run the presentations locally, first [install 
 6  presenterm](https://mfontanini.github.io/presenterm/guides/installation.html), clone this repo, and finally run:
 7  
 8  ```shell
 9  presenterm examples/<name-of-the-presentation>.md
10  ```
11  
12  # Demo
13  
14  [Source](/examples/demo.md)
15  
16  This is the main demo presentation, which showcases most features and uses the default dark theme.
17  
18  This is how it looks like when rendered:
19  
20  ![](/docs/src/assets/demo.gif)
21  
22  # Code
23  
24  [Source](/examples/code.md)
25  
26  This example contains some piece of code and showcases some different styling properties to make it look a bit different 
27  than how it looks like by default by using:
28  
29  * Use left alignment for code blocks.
30  * No background for code blocks.
31  
32  [![asciicast](https://asciinema.org/a/irNPKwEkPZzFbQP6jIKfVL30b.svg)](https://asciinema.org/a/irNPKwEkPZzFbQP6jIKfVL30b)
33  
34  # Footer
35  
36  [Source](/examples/footer.md)
37  
38  This example uses a template-style footer, which lets you place some text on the left, center, and right of every slide. 
39  A few template variables, such as `current_slide` and `total_slides` can be used to reference properties of the 
40  presentation.
41  
42  ![](../docs/src/assets/example-footer.png)
43  
44  # Columns
45  
46  [Source](/examples/columns.md)
47  
48  This example shows how column layouts and pauses interact with each other. Note that the image shows up as pixels 
49  because asciinema doesn't support these and it will otherwise look like a normal image if your terminal supports images.
50  
51  [![asciicast](https://asciinema.org/a/x2tTDt0BIesvOXeal3UpdzMHp.svg)](https://asciinema.org/a/x2tTDt0BIesvOXeal3UpdzMHp)
52  
53  # Speaker notes
54  
55  [Source](/examples/speaker-notes.md)
56  
57  This example shows how to use speaker notes.
58  
59  [![asciicast](https://asciinema.org/a/ETusvlmHuHrcLKzwa0CMQRX2J.svg)](https://asciinema.org/a/ETusvlmHuHrcLKzwa0CMQRX2J)
60  
61  # Custom introduction slides
62  
63  [Source](/examples/custom-intro-slides.md)
64  
65  This example various custom introduction slides that contain images placed in different layouts. Note that the images 
66  looks pixelated because of asciinema but they will otherwise look normal in your terminal.
67  
68  [![asciicast](https://asciinema.org/a/sBeAMJbpBxqKA2gF2RI3MmLT7.svg)](https://asciinema.org/a/sBeAMJbpBxqKA2gF2RI3MmLT7)