Skip to content

zenika-open-source/cheatsheets

Repository files navigation

Cheatsheets

🤩 A collaborative list of awesome cheatsheets. Feel free to contribute.

Objective

This project intend to allow everyone to create cheatsheet without programming skills. The main objectives are :

  • Build a easy-to-use and easy-to-maintain engine to generate cheatsheets
  • Use the well known markdown format to create it
  • Offer a way to create and use different templates to render document
  • Automatically build a website with all created cheatsheets
  • Allow to export it as a simple recto-verso PDF

workflow

Live demo

You can explore a live demo of this project here

Quick Start

To create your very first cheatsheets, follow this Quick Start Guide

Template Configuration

Cheatsheets are generated from Markdown files located in the cheatsheets folder. To configure the template and styles used in generating the Markdown, please refer to the config.json file. To understand how it works and how you can configure it, please follow the Template Grid Flow.

Contributing

If you'd like to contribute to this project, please follow our contribution guidelines.

License

This project is open-source and available under the Apache License.

Contributors


Liollury

Syeda Maham Fahim

Xavier Cassel

Benjamin Bourgeois

mguilliot

All Contributors  with love by zenika