https://github.com/owickstrom/automating-the-build-of-your-technical-presentation-template
The full template for "Automating the Build of your Technical Presentation"
https://github.com/owickstrom/automating-the-build-of-your-technical-presentation-template
Last synced: 3 months ago
JSON representation
The full template for "Automating the Build of your Technical Presentation"
- Host: GitHub
- URL: https://github.com/owickstrom/automating-the-build-of-your-technical-presentation-template
- Owner: owickstrom
- License: mpl-2.0
- Created: 2017-09-24T14:10:33.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-09-24T14:59:51.000Z (over 7 years ago)
- Last Synced: 2025-01-01T13:23:13.783Z (5 months ago)
- Language: TeX
- Size: 9.77 KB
- Stars: 26
- Watchers: 5
- Forks: 9
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# "Automating the Build of your Technical Presentation" -- The Template
This is a template for technical presentations written in Markdown, generating
PDF output using [Pandoc][] and [Beamer][]. Source code snippets are included
using [pandoc-include-code][]. Diagrams are generated using [Graphviz][] and/or
[PlantUML].
## Samples
* [With Notes (Presenter PDF)](https://wickstrom.tech/assets/slides.pdf)
* [Without Notes (Handout)](https://wickstrom.tech/assets/slides-no-notes.pdf)
## Requirements
* A LaTeX distribution, e.g. [TeX Live](https://www.tug.org/texlive/) or
[MacTeX](http://www.tug.org/mactex/).
* [Graphviz][]
* [Pandoc][] (version 2.0)
* [pandoc-include-code][]
* [Oracle JRE/JDK](http://www.oracle.com/technetwork/java/javase/downloads/index.html)
All the above dependencies' executables need to be on your PATH.
## Usage
1. Download this repository as a ZIP file, or clone it with git, and start
hacking away at your own presentation!
2. Write your slides in `src/slides.md`. There's a number of examples on how
you can include content and write notes in the existing file.
3. Add Graphviz diagrams to `src/uml/*.uml.txt` and PlantUML diagrams to
`src/uml/*.uml.txt`. There are some examples provided that you can modify
or remove.
## Build
Make slide handouts and slides with notes:
```
make slides
```
Start [pdfpc][] presenter:
```
make present
```
## License
[Mozilla Public License Version 2.0](LICENSE)
[Pandoc]: https://pandoc.org
[Beamer]: https://en.wikipedia.org/wiki/Beamer_(LaTeX)
[pandoc-include-code]: https://github.com/owickstrom/pandoc-include-code
[Graphviz]: http://graphviz.org
[PlantUML]: http://plantuml.com
[pdfpc]: https://pdfpc.github.io