Skip to content

liusancai/reference

 
 

Repository files navigation

Reference

love License contributors forks starts

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

About

⭕ Share quick reference cheat sheet for developers.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • EJS 38.1%
  • JavaScript 34.1%
  • CSS 15.0%
  • HTML 12.4%
  • Dockerfile 0.4%