https://github.com/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.
https://github.com/roguh/cheatsheets
Last synced: about 1 month ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/roguh/cheatsheets
- Owner: roguh
- License: gpl-3.0
- Created: 2018-04-11T16:41:43.000Z (about 8 years ago)
- Default Branch: main
- Last Pushed: 2021-11-22T05:04:16.000Z (over 4 years ago)
- Last Synced: 2026-04-07T06:36:27.587Z (2 months ago)
- Language: Python
- Homepage:
- Size: 496 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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.
