Skip to content

Latest commit

 

History

History
75 lines (56 loc) · 3.06 KB

README.md

File metadata and controls

75 lines (56 loc) · 3.06 KB

pandoc-slides build e2e slsa 2

A Template for RevealJS Slides written in Markdown

Prerequisites

  • container engine
    • docker - most popular container engine
    • podman - a daemonless container engine
  • make 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

  • Adjust optional definitions in metadata.yaml to your needs

  • Fill the markdown file 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

  • 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 - a comprehensive library for creating static plot in python
  • graphviz - open source graph visualization software
  • plantuml - easily create beautiful uml diagrams from simple text

thanks to pandocfilters and imagine are rendered as image inside final html

Note

there is a special section inside example/slides.md
for better understanding how it work and how to use it

Note

imagine global configuration inside metadata.yaml or
config per block inside code-block header

Note

matplotlib global configuration inside matplotlibrc loaded at startup

Acknowledgements

Related project pandoc-thesis