https://github.com/andros21/pandoc-slides

A Template for RevealJS Slides written in Markdown
https://github.com/andros21/pandoc-slides

apko chainguard-images cosign docker gh-pages graphviz html matplotlib pandoc plantuml revealjs

Last synced: 3 days ago
JSON representation

A Template for RevealJS Slides written in Markdown

• Host: GitHub
• URL: https://github.com/andros21/pandoc-slides
• Owner: andros21
• License: gpl-3.0
• Created: 2022-09-27T16:08:22.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2025-01-12T07:52:05.000Z (20 days ago)
• Last Synced: 2025-01-12T08:32:17.509Z (20 days ago)
• Topics: apko, chainguard-images, cosign, docker, gh-pages, graphviz, html, matplotlib, pandoc, plantuml, revealjs
• Language: Makefile
• Homepage: https://andros21.github.io/pandoc-slides
• Size: 464 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
 pandoc-slides 

    



    



    





A Template for RevealJS Slides written in Markdown

### Prerequisites

* container engine

    * [`docker`](https://www.docker.com/) - most popular container engine

    * [`podman`](https://podman.io/) - a daemonless container engine

* [`make`](https://www.gnu.org/s/make/manual/make.html) command - build automation tool

> [!WARNING]\

> supported platforms

>  * `amd64-unknown-linux`

>  * `arm64-unknown-linux`

>  * `amd64-apple-darwin`

>  * `arm64-apple-darwin`

### Usage

* Put the title of your slides, your name and other meta information in [`metadata.yaml`](metadata.yaml)

* Adjust optional definitions in [`metadata.yaml`](metadata.yaml) to your needs

* Fill the markdown file [`md/slides.md`](md/slides.md) with your content

    > [!NOTE]\

    > you will find some help regarding the use of Markdown inside it

    > [!WARNING]\

    > do not forget to reflect the changed filenames in [`Makefile`](Makefile)

* Create `pandoc-slides` container with everything you need to build slides: `make container`

* Build the slides: `make`

* Clean up

    * to remove temporary (generated) filed: `make clean`

    * to also remove the generated slides (html): `make distclean`

    * to remove container: `make containerclean`

    * to remove image: `make imageclean`

> [!NOTE]\

> the above mentioned files constitute a minimal working example,\

> to start your own project, simply clone this project and customize the files mentioned above

> [!NOTE]\

> to upgrade to latest `pandoc-slides` image `make containerupgrade`

### Pandoc filters

Inside markdown source is possible to insert code-blocks of these available tools:

* [`matplotlib`](https://matplotlib.org/) - a comprehensive library for creating static plot in python

* [`graphviz`](https://graphviz.org/) - open source graph visualization software

* [`plantuml`](https://plantuml.com/) - easily create beautiful uml diagrams from simple text

thanks to [`pandocfilters`](https://github.com/jgm/pandocfilters) and [`imagine`](https://github.com/andros21/imagine) are rendered as image inside final html

> [!NOTE]\

> there is a special section inside [`example/slides.md`](example/slides.md)\

> for better understanding how it work and how to use it

> [!NOTE]\

> `imagine` global configuration inside [`metadata.yaml`](metadata.yaml) or\

> config per block inside code-block header

> [!NOTE]\

> `matplotlib` global configuration inside [`matplotlibrc`](matplotlibrc) loaded at startup

### Acknowledgements

Related project [`pandoc-thesis`](https://github.com/andros21/pandoc-thesis)