https://github.com/lmmentel/cookiecutter-mdbeamer
https://github.com/lmmentel/cookiecutter-mdbeamer
beamer beamer-theme latex markdown markdown-to-slide pandoc
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/lmmentel/cookiecutter-mdbeamer
- Owner: lmmentel
- Created: 2017-11-17T15:09:13.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-07-18T20:17:58.000Z (almost 3 years ago)
- Last Synced: 2025-01-28T23:28:43.684Z (4 months ago)
- Topics: beamer, beamer-theme, latex, markdown, markdown-to-slide, pandoc
- Language: Lua
- Size: 185 KB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# cookiecutter-mdbeamer
This is a [cookiecutter] template for a quickly and comfortably
creating [beamer] presentations without all the tedious typing
associated with [LaTeX].
The slides contents are prepared using [markdown] which minimizes
the typing and then the pdf slides are build through an
automated process first using [pandoc] to convert `.md` to `.tex`.
Then `.tex` is converted to `.pdf` through [latexmk] using [luatex]
as the [LaTeX] engine.
## Style
The appearance is largely based on the [metropolis theme](https://github.com/matze/mtheme)
however some of the color and font schemes are customized. To take full advantage
of the modified theme install the two following fonts:
- [Yanone Kaffeesatz](http://yanone.de/fonts/kaffeesatz/) - used for the titles and structure elements
- [roboto](https://www.ctan.org/tex-archive/fonts/roboto) - slide contents
The syntax highlighting is using the [minted](https://ctan.org/tex-archive/macros/latex/contrib/minted/)
package and therefore requires [Python](https://www.python.org/) and [pygments](http://pygments.org/)
to work properly.
## Usage
First make sure you have the following dependencies installed:
- [GNU make](https://www.gnu.org/software/make/)
- [pandoc]
- [LaTeX]
- [luatex]
- [latexmk]
- [cookiecutter]
- [pygments]
- [minted.lua](https://github.com/pandoc/lua-filters/tree/master/minted)
Install [cookiecutter] and:
```bash
$ cookiecutter [email protected]:lmmentel/cookiecutter-mdbeamer.git
```
After modifying the `.md` file with the slide contents simply type
```bash
make pdf
```
and the slides should be built in the `build` directory.
### Options
A few selected options are available to to further customize the appearance:
- `aspectratio` - aspect ratio of the slides, allowed values are: `1610` for 16:10, `169` for 16:9, `149` for 14:9, `141` for 1.41:1, `54` for 5:4, `43` for 4:3 and `32` for 3:2
- `fontsize` - size of the document font, default `10pt`
## Example
The example slides are avaialble also as a [pdf](example/slides.pdf).
[beamer]: https://en.wikipedia.org/wiki/Beamer_(LaTeX)
[cookiecutter]: https://cookiecutter.readthedocs.io/en/latest/installation.html
[LaTeX]: https://www.latex-project.org/
[latexmk]: https://www.ctan.org/pkg/latexmk/
[luatex]: http://www.luatex.org/
[markdown]: https://daringfireball.net/projects/markdown/
[pandoc]: https://pandoc.org/
[pygments]: http://pygments.org/