Welcome to pandoc-beamer-block’s documentation!

Installation

Python package pre-commit Coveralls Scrutinizer Code Climate CodeFactor Codacy PyPI version PyPI format Latest release Last commit License Python version Poetry version Pandoc version Downloads Development Status Docs Code style: black Repo Size Code Size Source Rank

pandoc-beamer-block is a pandoc filter for adding beamer block to divs.

Instructions

pandoc-beamer-block requires python, a programming language that comes pre-installed on linux and Mac OS X, and which is easily installed on Windows.

Install pandoc-beamer-block using the bash command

$ pipx install pandoc-beamer-block

To upgrade to the most recent release, use

$ pipx upgrade pandoc-beamer-block

pipx is a script to install and run python applications in isolated environments from the Python Package Index, PyPI. It can be installed using instructions given here.

Getting Help

If you have any difficulties with pandoc-beamer-block, please feel welcome to file an issue on github so that we can help.

Notes

Usage

To apply the filter, use the following option with pandoc:

$ pandoc --filter pandoc-beamer-block

Explanation

In the metadata block, specific set of classes can be defined to decorate div elements by blocks

The metadata block add information using the pandoc-beamer-block entry by a list of definitions:

pandoc-beamer-block:
  - classes: [info]
  - classes: [alert]
    type: alert

The metadata block above is used to add a block environment around divs which have info class and a alertblock environment to divs that have only a alert class.

Each entry of pandoc-beamer-block is a YAML dictionary containing:

  • classes: the set of classes of the divs to which the transformation will be applied. This parameter is mandatory.

  • type: the block type (either alert, example, info, theorem, proof, corollary, definition, lemma and fact)

Example

Demonstration: Using pandoc-beamer-block-sample.txt as input gives output file in pandoc-beamer-block-sample.pdf.

$ pandoc \
    -t beamer \
    -V theme:Warsaw \
    --filter pandoc-beamer-block \
    -o docs/images/pandoc-beamer-block-sample.pdf \
    docs/images/pandoc-beamer-block-sample.txt