Reference is a collection of cheat sheets contributed by open source angels. It shares a quick reference cheat sheet for developers in a nice layout. [ 中文版 | ... ]

We encourage you to share your own cheat sheets with the community and make Reference even better. If you notice a cheat sheet that could be improved, feel free to submit a pull request.

Note: The original domain for this project was quickref.me, which was acquired by a US-based company. Since then, cheatsheets.zip is the primary and maintained domain (All within the bounds of the agreements).

You can view the most up-to-date cheat sheets live at https://cheatsheets.zip.

Reference provides cheat sheets for the following:

.
├── source
│   ├── _posts   # Cheat sheet source files
│   │   ├── awk.md
│   │   ├── vim.md # => https://cheatsheets.zip/vim
│   │   ├── php.md
│   │   ├── css.md # => https://cheatsheets.zip/css
│   │   ├── ...
│   └── widget   # Widget files
│       └── chmod.html
├── public       # Distribution files
├── _config.yml
├── gulpfile.js
├── package.json
├── postcss.config.js
├── tailwind.config.js
└── themes
    └── coo      # Theme files

We would like to extend our gratitude to you for considering a contribution to Reference. Your support is what makes this project a truly resource. Please note that the primary domain for accessing the most up-to-date content is cheatsheets.zip. Feel free to submit issues and enhancement requests.

For consistency, we encourage you to refer to the https://cheatsheets.zip/quickref when creating or editing cheat sheets. To get started with development, follow these steps:

1. Clone Github repo git clone https://github.com/Fechin/reference.git
2. Install npm package manager (Read installation guide)
3. Run npm install in the root folder to install dependencies.
4. Run npm run dev to start a dev server. This serves the project and live reloads when any files are changed, then visit http://127.0.0.1:4000 preview.
5. Submit a pull request and wait for it to be reviewed and merged.

To create or edit a cheat sheet, you'll need to create or edit a markdown file in source/_posts/{filename}.md. The file should include a front matter section with the following format:

---
title: CheatSheets
date: 2020-11-25 18:28:43
icon: icon-style
background: bg-emerald-600
tags:
categories:
- Other
  intro: This is a reference of styles that you can use on quickref cheat sheets!
---

Only the title and intro fields are required, and the other options can be left blank.

Stay up-to-date with our project by following us on Twitter! Get all the latest news and updates right in your feed. It's the perfect way to stay in the loop.

The project is licensed under the GPL-3.0 License and is maintained by Fechin.