roguh / cheatsheets

Toolkit for converting notes into compact PDFs suitable for quick reference sheets, cheatsheets, cribsheets, etc. Notes can be written in markdown, are rendered to PDF by Pandoc.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Cheatsheets

Markdown Files

Cheatsheets are written in markdown. See cheatsheets/template.md for an example.

Requirements

You need Pandoc, a suitable LaTeX installation, and the pandocfilters Python package.

Render a file

Use render.sh.

./render.sh file.md pdf
./render.sh file.md tex
./render.sh file.md native  # useful for debugging pandoc filters

LaTeX Files

With these configuration files, Pandoc renders markdown files into two-column cheatsheets where every section is drawn in a colored box.

header.yaml sets most LaTeX options
section2box.py converts \section{X} into \begin{tcolorbox}[title=\section{X}]
template.latex fancyhdr, surround document in multicols and tcolorbox environments

Samples and template files

See samples/template.md for a more concrete example and samples/empty.md for an empty starter file.

About

Toolkit for converting notes into compact PDFs suitable for quick reference sheets, cheatsheets, cribsheets, etc. Notes can be written in markdown, are rendered to PDF by Pandoc.

License:GNU General Public License v3.0


Languages

Language:Python 63.0%Language:Shell 30.8%Language:Makefile 6.1%