Git Product home page Git Product logo

reference's Introduction

Reference

love License Follow us on Twitter

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

We're happy to see your best skill cheat sheets in Reference, If you see a cheatsheet here is not fit, you can fix it or provide a better cheatsheet by submitting a PR.

Live Demo

Read the cheatsheet gracefully https://quickref.me

Quick reference

Directory structure

.
├── source
│   ├── _posts   # Cheatsheet source files
│   │   ├── awk.md
│   │   ├── vim.md # => https://quickref.me/vim
│   │   ├── php.md
│   │   ├── css.md # => https://quickref.me/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

Contributing

Thanks for your interest on contributing to reference, it's people like you that make QuickRef.ME such a amazing site 🎉🎉. Feel free to submit issues and enhancement requests.

It's a good practice to refer to the cheatsheet of the QuickRef Cheatsheet.

Development setup

  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. Send us pull request and chill.

A source/_posts/{filename}.md file will be processed into a cheat sheet, let's create or edit a markdown file:

Front Matter

---
title: QuickRef
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 cheatsheets!
---

Just need title and intro, and ignore other options. I will complete it if it can be released.

CSS classes

QuickRefs uses markdown-it-attrs and supports adding classes via its syntax. Also, there is a reference of styles that you can use on quickref.me cheat sheets: https://quickref.me/quickref

License

MIT © Fechin

reference's People

Contributors

randy8080 avatar fechin avatar jessinthecloud avatar kod3x avatar matheusfelipeog avatar deividgp avatar teetajp avatar bradgermain avatar xelemental avatar pratikpwr avatar larry4xie avatar shenmian avatar adam-cowley avatar keivan-sf avatar kebap avatar lexitus avatar iamaliyousefi avatar jiayuehua avatar xiaolai avatar whoizit avatar aspari-lore avatar hioz avatar hantianwei avatar ceo0x avatar rishabh2804 avatar imaryan08 avatar oxygels avatar myinstagramalternative avatar oceluspro avatar mubashirchandle avatar

Stargazers

Roman avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.