Skip to content

billyquith/cheatsheet

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

98 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Cheatsheet

Summary

This is a simple tool for displaying summarised information as cheatsheets. The sheets are formatted using Markdown, like you are reading now. Once parsed they are are then transformed into browsable webpages.

Usage

To use just git clone this repository somewhere and open the html/index.html file. To open a specific sheet use URL:

file:///PATH_TO_CHEATSHEET/index.html?sheet=SHEETNAME

To add new sheets, create a new file sheets/SHEETNAME.md.

Formatting

Formatting is standard Markdown:

  • H2 headers become section names.
  • Tables are allowed.
  • Value-comment lists are a markup extension.
  • Pop-up examples.

See the "eg" example sheet and its source for more examples.

Useful links

Licence

The project is a standalone tool and so is licensed under GPL.

GPLv3 - GNU GENERAL PUBLIC LICENSE]. Version 3, 29 June 2007.

About

Simple cheatsheet generation in a browser

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published