mirror of
https://github.com/Fechin/reference.git
synced 2026-11-20 21:23:11 +03:00
Merge remote-tracking branch 'origin/main'
This commit is contained in:
commit
44409959f1
1 file changed
+224
-25
@@ -1,28 +1,219 @@
|
||||
# Reference
|
||||
|
||||
# 📖 Reference - Cheat Sheets for Developers
|
||||
|
||||
[](#)
|
||||
[](https://github.com/Fechin/reference/blob/main/LICENSE)
|
||||
[](https://twitter.com/FechinLi)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Reference is a collection of cheatsheets contributed by open source angels. It shares a quick reference cheat sheet for developers in a nice layout. \[ [中文版](https://github.com/jaywcjlove/reference) | ... \]
|
||||
|
||||
|
||||
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](#contributing).
|
||||
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](#contributing).
|
||||
|
||||
|
||||
## Live Demo
|
||||
Read the cheatsheet gracefully https://quickref.me
|
||||
|
||||
|
||||
## 👀 Live Demonstration
|
||||
|
||||
You can view the cheat sheets live at https://quickref.me
|
||||
|
||||
[](https://quickref.me/)
|
||||
|
||||
|
||||
Reference provides cheat sheets for the following:
|
||||
|
||||
## Directory structure
|
||||
## 📚 Cheat Sheets List
|
||||
|
||||
Reference provides cheat sheets for the following:
|
||||
|
||||
|
||||
<details>
|
||||
<summary>Programming</summary>
|
||||
|
||||
- [Kubernetes](https://quickref.me/kubernetes.html): This page contains a list of commonly used kubectl commands and flags.
|
||||
- [ES6](https://quickref.me/es6.html): A quick reference cheatsheet of what's new in JavaScript for ES2015, ES2016, ES2017, ES2018 and beyond
|
||||
- [MATLAB](https://quickref.me/matlab.html): This quick reference cheat sheet provides an example introduction to using the [MATLAB](https://mathworks.cn/) scientific computing language to get started quickly
|
||||
- [C](https://quickref.me/c.html): C quick reference cheat sheet that provides basic syntax and methods.
|
||||
- [INI](https://quickref.me/ini.html): This is a quick reference cheat sheet for understanding and writing INI-format configuration files.
|
||||
- [LaTeX](https://quickref.me/latex.html): This cheat sheet summarizes a reference list of [LaTeX](https://www.latex-project.org/) commonly used display math notation and some application examples of [KaTeX](https://katex.org/).
|
||||
- [Rust](https://quickref.me/rust.html): The Rust quick reference cheat sheet that aims at providing help on writing basic syntax and methods.
|
||||
- [C#](https://quickref.me/cs.html): C# quick reference cheat sheet that provides basic syntax and methods.
|
||||
- [Laravel](https://quickref.me/laravel.html): [Laravel](https://laravel.com/docs/8.x/) is an expressive and progressive web application framework for PHP.
|
||||
This cheat sheet provides a reference for common commands and features for Laravel 8.
|
||||
- [Dart](https://quickref.me/dart.html): A Dart cheat sheet with the most important concepts, functions, methods, and more. A complete quick reference for beginners.
|
||||
- [JSON](https://quickref.me/json.html): This is a quick reference cheat sheet for understanding and writing JSON format configuration files.
|
||||
- [HTML](https://quickref.me/html.html): This HTML quick reference cheat sheet lists the common HTML and HTML5 tags in readable layout.
|
||||
- [GraphQL](https://quickref.me/graphql.html): This quick reference cheat sheet provides a brief overview of GraphQL.
|
||||
- [C++](https://quickref.me/cpp.html): C++ quick reference cheat sheet that provides basic syntax and methods.
|
||||
- [Java](https://quickref.me/java.html): This cheat sheet is a crash course for Java beginners and help review the basic syntax of the Java language.
|
||||
- [PHP](https://quickref.me/php.html): This [PHP](https://www.php.net/manual/en/) cheat sheet provides a reference for quickly looking up the correct syntax for the code you use most frequently.
|
||||
- [Docker](https://quickref.me/docker.html): This is a quick reference cheat sheet for [Docker](https://docs.docker.com/get-started/). And you can find the most common Docker commands here.
|
||||
- [TOML](https://quickref.me/toml.html): This is a quick reference cheat sheet to the TOML format configuration file syntax.
|
||||
- [YAML](https://quickref.me/yaml.html): This is a quick reference cheat sheet for understanding and writing YAML format configuration files.
|
||||
- [CSS 3](https://quickref.me/css.html): This is a quick reference cheat sheet for CSS goodness, listing selector syntax, properties, units and other useful bits of information.
|
||||
- [jQuery](https://quickref.me/jquery.html): This [jQuery](https://jquery.com/) cheat sheet is a great reference for both beginners and experienced developers.
|
||||
- [JavaScript](https://quickref.me/javascript.html): A JavaScript cheat sheet with the most important concepts, functions, methods, and more. A complete quick reference for beginners.
|
||||
- [Python](https://quickref.me/python.html): The [Python](https://www.python.org/) cheat sheet is a one-page reference sheet for the Python 3 programming language.
|
||||
- [Sass](https://quickref.me/sass.html): This is a quick reference cheat sheet that lists the most useful features of [SASS](https://sass-lang.com).
|
||||
- [Go](https://quickref.me/go.html): This cheat sheet provided basic syntax and methods to help you using [Go](https://go.dev/).
|
||||
- [Markdown](https://quickref.me/markdown.html): This is a quick reference cheat sheet to the Markdown syntax.
|
||||
- [Bash](https://quickref.me/bash.html): This is a quick reference cheat sheet to getting started with linux bash shell scripting.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Toolkit</summary>
|
||||
|
||||
- [ChatGPT](https://quickref.me/chatgpt.html): This cheat sheet lists out prompts and tips from all over the world on how to use ChatGPT effectively
|
||||
- [VSCode](https://quickref.me/vscode.html): This VSCode (Visual Studio Code) quick reference cheat sheet shows its keyboard shortcuts and commands.
|
||||
- [Mitmproxy](https://quickref.me/mitmproxy.html): [mitmproxy](https://mitmproxy.org/) is a free and open source interactive HTTPS proxy. This is a quick reference cheat sheet to the mitmproxy.
|
||||
- [XPath](https://quickref.me/xpath.html): This is an [XPath](https://en.wikipedia.org/wiki/XPath) selectors cheat sheet, which lists commonly used XPath positioning methods and CSS selectors
|
||||
- [Emacs](https://quickref.me/emacs.html): [Emacs](https://www.gnu.org/software/emacs) is the extensible, customizable, self-documenting real time display text editor.
|
||||
This reference was made for Emacs 27.
|
||||
- [Emmet](https://quickref.me/emmet.html): [Emmet](https://emmet.io/) is a web-developer’s toolkit for boosting HTML & CSS code writing, which allows you to write large HTML code blocks at speed of light using well-known CSS selectors.
|
||||
- [RegEX](https://quickref.me/regex.html): A quick reference for regular expressions (regex), including symbols, ranges, grouping, assertions and some sample patterns to get you started.
|
||||
- [Vim](https://quickref.me/vim.html): A useful collection of [Vim](http://www.vim.org/) 8.2 quick reference cheat sheets to help you learn vim editor faster.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Linux Command</summary>
|
||||
|
||||
- [Curl](https://quickref.me/curl.html): This [Curl](https://github.com/curl/curl) cheat sheet contains commands and examples of some common Curl tricks.
|
||||
- [PM2](https://quickref.me/pm2.html): [PM2] is a daemon process manager that will help you manage and keep your application online. Getting started with PM2 is straightforward, it is offered as a simple and intuitive CLI.
|
||||
- [Chmod](https://quickref.me/chmod.html): This quick reference cheat sheet provides a brief overview of file permissions, and the operation of the chmod command
|
||||
- [Tmux](https://quickref.me/tmux.html): The tmux cheat sheet quick reference of most commonly used shortcuts and commands
|
||||
- [Lsof](https://quickref.me/lsof.html): This quick reference cheat sheet provides various for using lsof command.
|
||||
- [SSH](https://quickref.me/ssh.html): This quick reference cheat sheet provides various for using SSH.
|
||||
- [Netstat](https://quickref.me/netstat.html): This quick reference cheat sheet provides various for using netstat command.
|
||||
- [Screen](https://quickref.me/screen.html): This is a quick reference guide cheat sheet for the screen command.
|
||||
- [Awk](https://quickref.me/awk.html): This is a one page quick reference cheat sheet to the [GNU awk](https://www.gnu.org/software/gawk/manual/gawk.html), which covers commonly used awk expressions and commands.
|
||||
- [Find](https://quickref.me/find.html): This is a quick reference list of cheatsheet for linux find command, contains common options and examples.
|
||||
- [Sed](https://quickref.me/sed.html): [Sed](https://www.gnu.org/software/sed/manual/sed.html) is a stream editor, this sed cheat sheet contains sed commands and some common sed tricks.
|
||||
- [Cron](https://quickref.me/cron.html): [Cron](https://en.wikipedia.org/wiki/Cron) is most suitable for scheduling repetitive tasks. Scheduling one-time tasks can be accomplished using the associated at utility.
|
||||
- [Git](https://quickref.me/git.html): This cheat sheet summarizes commonly used Git command line instructions for quick reference.
|
||||
- [Grep](https://quickref.me/grep.html): This cheat sheet is intended to be a quick reminder for the main concepts involved in using the command line program grep and assumes you already understand its usage.
|
||||
- [Netcat](https://quickref.me/nc.html): This cheat sheet provides various for using Netcat on both Linux and Unix.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Python</summary>
|
||||
|
||||
- [Numpy](https://quickref.me/numpy.html): [NumPy](https://numpy.org/) is the fundamental package for scientific computing with Python. This cheat sheet is a quick reference for NumPy beginners.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Database</summary>
|
||||
|
||||
- [Neo4j](https://quickref.me/neo4j.html): A Neo4j cheat sheet with getting started resources and information on how to query the database with Cypher.
|
||||
- [PostgreSQL](https://quickref.me/postgres.html): The [PostgreSQL](https://www.postgresql.org/docs/current/) cheat sheet provides you with the common PostgreSQL commands and statements.
|
||||
- [Redis](https://quickref.me/redis.html): This is a [redis](https://redis.io/) quick reference cheat sheet that lists examples of redis commands
|
||||
- [MySQL](https://quickref.me/mysql.html): The SQL cheat sheet provides you with the most commonly used SQL statements for your reference.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Keyboard Shortcuts</summary>
|
||||
|
||||
- [Adobe Photoshop](https://quickref.me/adobe-photoshop.html): A visual cheat-sheet for the 283 keyboard shortcuts found in Adobe Photoshop
|
||||
- [Apex Legends](https://quickref.me/apex-legends.html): A visual cheat-sheet for the 27 default keyboard shortcuts found in Apex Legends
|
||||
- [Figma](https://quickref.me/figma.html): A visual cheat-sheet for the 119 keyboard shortcuts found in Figma
|
||||
- [Microsoft Teams](https://quickref.me/microsoft-teams.html): A visual cheat-sheet for the 38 keyboard shortcuts found in Microsoft Teams
|
||||
- [TablePlus](https://quickref.me/table-plus.html): A visual cheat-sheet for the 34 keyboard shortcuts found in TablePlus
|
||||
- [Bear](https://quickref.me/bear-notes.html): A visual cheat-sheet for the 66 keyboard shortcuts found in Bear. This application is MacOS-only.
|
||||
- [Feedly](https://quickref.me/feedly.html): A visual cheat-sheet for the 25 keyboard shortcuts found on the Feedly app
|
||||
- [FileZilla](https://quickref.me/filezilla.html): A visual cheat-sheet for the 30 keyboard shortcuts found on the FileZilla program
|
||||
- [Reddit](https://quickref.me/reddit.html): A visual cheat-sheet for the 17 keyboard shortcuts found on Reddit.com
|
||||
- [Slack](https://quickref.me/slack.html): A visual cheat-sheet for the 62 keyboard shortcuts found in Slack
|
||||
- [SoundCloud](https://quickref.me/soundcloud.html): A visual cheat-sheet for the 22 keyboard shortcuts found on SoundCloud
|
||||
- [Twitter](https://quickref.me/twitter.html): A visual cheat-sheet for the 26 keyboard shortcuts found on Twitter
|
||||
- [Android Studio](https://quickref.me/android-studio.html): A visual cheat-sheet for the 130 keyboard shortcuts found in the Andriod Studio software
|
||||
- [Github](https://quickref.me/github.html): A visual cheat-sheet for the 80 keyboard shortcuts found on Github.com
|
||||
- [Shopify](https://quickref.me/shopify.html): A visual cheat-sheet for the 50 keyboard shortcuts found on the Shopify website
|
||||
- [Zoom](https://quickref.me/zoom.html): A visual cheat-sheet for the 32 keyboard shortcuts found in Zoom. These shortcuts are for MacOS, for Windows visit /zoom-windows.
|
||||
- [Adobe XD](https://quickref.me/adobe-xd.html): A visual cheat-sheet for the 97 keyboard shortcuts found in Adobe XD
|
||||
- [Firefox](https://quickref.me/firefox.html): A visual cheat-sheet for the 116 keyboard shortcuts found in Firefox
|
||||
- [PhpStorm](https://quickref.me/phpstorm.html): A visual cheat-sheet for the 96 keyboard shortcuts found in JetBrains PhpStorm
|
||||
- [Postman](https://quickref.me/postman.html): A visual cheat-sheet for the 23 keyboard shortcuts found in Postman
|
||||
- [Webflow](https://quickref.me/webflow.html): A visual cheat-sheet for the 41 keyboard shortcuts found in Webflow
|
||||
- [Adobe Lightroom CC](https://quickref.me/adobe-lightroom.html): A visual cheat-sheet for the 251 keyboard shortcuts found in Adobe Lightroom CC
|
||||
- [1Password](https://quickref.me/1password.html): A cheat sheet for 1password's keyboard shortcuts in Mac, Windows, iOS, Linux.
|
||||
- [Affinity Designer](https://quickref.me/affinity-designer.html): A visual cheat-sheet for the 108 keyboard shortcuts found in Affinity Designer
|
||||
- [Pocket](https://quickref.me/pocket.html): A visual cheat-sheet for the 36 keyboard shortcuts found on Pocket for Web
|
||||
- [Trello](https://quickref.me/trello.html): A visual cheat-sheet for the 29 keyboard shortcuts found on Trello
|
||||
- [Audacity](https://quickref.me/audacity.html): A visual cheat-sheet for the 135 default keyboard shortcuts found in Audacity
|
||||
- [Framer X](https://quickref.me/framer-x.html): A visual cheat-sheet for the 45 keyboard shortcuts found in Framer X. This application is MacOS-only.
|
||||
- [Google Drive](https://quickref.me/google-drive.html): A visual cheat-sheet for the 54 keyboard shortcuts found in Google Drive on the web
|
||||
- [PuTTy](https://quickref.me/putty.html): A visual cheat-sheet for the 32 keyboard shortcuts found on the PuTTy app
|
||||
- [Sequel Pro](https://quickref.me/sequel-pro.html): A visual cheat-sheet for the 71 keyboard shortcuts found in Sequel Pro. This application is MacOS-only.
|
||||
- [Apple Music](https://quickref.me/apple-music.html): A visual cheat-sheet for the 62 keyboard shortcuts found in the Apple Music app. This application is MacOS-only.
|
||||
- [Blender](https://quickref.me/blender.html): A visual cheat-sheet for the 187 keyboard shortcuts found in Blender
|
||||
- [Obsidian](https://quickref.me/obsidian.html): A visual cheat-sheet for the 17 keyboard shortcuts found in the Obsidian knowledge base app.
|
||||
- [Telegram Desktop](https://quickref.me/telegram.html): A visual cheat-sheet for the 37 keyboard shortcuts found on the Telegram Desktop app
|
||||
- [YouTube](https://quickref.me/youtube.html): A visual cheat-sheet for the 18 keyboard shortcuts found on YouTube.com
|
||||
- [Airtable](https://quickref.me/airtable.html): A visual cheat-sheet for the 36 keyboard shortcuts found in Airtable
|
||||
- [Bitbucket](https://quickref.me/bitbucket.html): A visual cheat-sheet for the 35 keyboard shortcuts found on Bitbucket
|
||||
- [Fortnite](https://quickref.me/fortnite.html): A visual cheat-sheet for the 26 default keyboard shortcuts found in Fortnite
|
||||
- [Gmail](https://quickref.me/gmail.html): A visual cheat-sheet for the 90 keyboard shortcuts found on Gmail
|
||||
- [Sketch](https://quickref.me/sketch.html): A visual cheat-sheet for the 149 keyboard shortcuts found in Sketch. This application is MacOS-only.
|
||||
- [Spotify](https://quickref.me/spotify.html): A visual cheat-sheet for the 23 keyboard shortcuts found in Spotify
|
||||
- [Brave Browser](https://quickref.me/brave.html): A visual cheat-sheet for the 64 keyboard shortcuts found in the Brave browser
|
||||
- [KanbanMail](https://quickref.me/kanbanmail.html): A visual cheat-sheet for the 29 keyboard shortcuts found in KanbanMail
|
||||
- [Microsoft Outlook](https://quickref.me/outlook.html): A visual cheat-sheet for the 210 keyboard shortcuts found in Microsoft Outlook
|
||||
- [Principle](https://quickref.me/principle.html): A visual cheat-sheet for the 30 keyboard shortcuts found in Principle. This application is MacOS-only.
|
||||
- [Skype](https://quickref.me/skype.html): A visual cheat-sheet for the 31 keyboard shortcuts found in Skype
|
||||
- [Arduino IDE](https://quickref.me/arduino.html): A visual cheat-sheet for the 12 keyboard shortcuts found in the Arduino IDE
|
||||
- [Asana](https://quickref.me/asana.html): A visual cheat-sheet for the 40 keyboard shortcuts found in Asana
|
||||
- [Code Editor for iOS](https://quickref.me/code-editor-ios.html): A visual cheat-sheet for the 43 keyboard shortcuts found in the Code Editor for iOS app. This application is MacOS-only.
|
||||
- [Jira](https://quickref.me/jira.html): A visual cheat-sheet for the 44 keyboard shortcuts found in Jira
|
||||
- [Quip.com](https://quickref.me/quip.html): A visual cheat-sheet for the 52 keyboard shortcuts found in Quip
|
||||
- [WordPress](https://quickref.me/wordpress.html): A visual cheat-sheet for the 34 keyboard shortcuts found in the WordPress visual editor
|
||||
- [Chrome Developer Tools](https://quickref.me/chrome-devtools.html): A visual cheat-sheet for the 56 keyboard shortcuts found in Chrome's Developer Tools
|
||||
- [GIMP](https://quickref.me/gimp.html): A visual cheat-sheet for the 97 keyboard shortcuts found in GIMP
|
||||
- [Google Chrome](https://quickref.me/google-chrome.html): A visual cheat-sheet for the 65 keyboard shortcuts found in Google Chrome
|
||||
- [Todoist](https://quickref.me/todoist.html): A visual cheat-sheet for the 37 keyboard shortcuts found in Todoist
|
||||
- [TickTick](https://quickref.me/ticktick.html): A visual cheat-sheet for the 25 keyboard shortcuts found in the TickTick desktop app
|
||||
- [VLC Player](https://quickref.me/vlc.html): A visual cheat-sheet for the 82 keyboard shortcuts found in VLC Player
|
||||
- [Missive](https://quickref.me/missive.html): A visual cheat-sheet for the 83 keyboard shortcuts found in Missive
|
||||
- [Origami Studio](https://quickref.me/origami.html): A visual cheat-sheet for the 71 keyboard shortcuts found in Origami Studio. This application is MacOS-only.
|
||||
- [Sublime Text](https://quickref.me/sublime-text.html): A visual cheat-sheet for the 49 keyboard shortcuts found in Sublime Text
|
||||
- [Transmit](https://quickref.me/transmit.html): A visual cheat-sheet for the 62 keyboard shortcuts found in Transmit. This application is MacOS-only.
|
||||
- [Affinity Photo](https://quickref.me/affinity-photo.html): A visual cheat-sheet for the 177 keyboard shortcuts found in Affinity Photo
|
||||
- [Monday.com](https://quickref.me/monday.html): A visual cheat-sheet for the 24 keyboard shortcuts found on Monday.com
|
||||
- [Proto.io](https://quickref.me/proto-io.html): A visual cheat-sheet for the 48 keyboard shortcuts found in Proto.io
|
||||
- [Superhuman](https://quickref.me/superhuman.html): A visual cheat-sheet for the 105 keyboard shortcuts found in Superhuman. This application is MacOS-only.
|
||||
- [Vivaldi Browser](https://quickref.me/vivaldi.html): A visual cheat-sheet for the 69 default keyboard shortcuts found in the Vivaldi browser
|
||||
- [Finder](https://quickref.me/finder.html): A visual cheat-sheet for the 55 keyboard shortcuts found in Finder. This application is part of MacOS.
|
||||
- [GitLab](https://quickref.me/gitlab.html): A visual cheat-sheet for the 58 keyboard shortcuts found in GitLab
|
||||
- [Guitar Pro](https://quickref.me/guitar-pro.html): A visual cheat-sheet for the 129 keyboard shortcuts found in Guitar Pro
|
||||
- [Roam Research](https://quickref.me/roam.html): A visual cheat-sheet for the 45 keyboard shortcuts found on Roam Research
|
||||
- [SketchUp Pro](https://quickref.me/sketchup.html): A visual cheat-sheet for the 135 default keyboard shortcuts found in SketchUp Pro
|
||||
- [Unity 3D](https://quickref.me/unity-3d.html): A visual cheat-sheet for the 50 keyboard shortcuts found in Unity 3D
|
||||
- [IntelliJ IDEA](https://quickref.me/idea.html): IntelliJ IDEA is a very good Java IDE, most of its commands have shortcuts to keep your hands from leaving the keyboard
|
||||
- [WebStorm](https://quickref.me/webstorm.html): This quick reference cheat sheet lists the default keyboard shortcuts for WebStorm running on Windows/Linux or Mac
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Other</summary>
|
||||
|
||||
- [Google Search](https://quickref.me/google-search.html): This quick reference cheat sheet lists of Google advanced search operators.
|
||||
- [ASCII Code](https://quickref.me/ascii-code.html): This cheatsheet is a complete list of ASCII Code Table with their numbers and names.
|
||||
- [Aspect Ratio](https://quickref.me/aspect-ratio.html): This cheat sheet lists some common aspect ratios and their pixel resolutions. Always confirm your final delivery ratio when shooting.
|
||||
- [HTML Characters Entities](https://quickref.me/html-char.html): This cheatsheet is a complete list of HTML entities with their numbers and names. Also included is a full list of ASCII characters that can be represented in HTML.
|
||||
- [ISO 639-1 Language Code](https://quickref.me/iso-639-1.html): This is a list of the ISO language codes that conform to the ISO 639-1 standard, it provide reference for multi-language website.
|
||||
- [Resolutions](https://quickref.me/resolutions.html): This cheat sheet lists screen sizes, viewport size and CSS media queries for popular Phones, Tablets, Laptops and Watches
|
||||
- [HTTP Status Code](https://quickref.me/http-status-code.html): The http status codes cheat sheet. a quick reference to every HTTP status code.
|
||||
- [Emoji](https://quickref.me/emoji.html): Some of the emoji codes are not super easy to remember, so here is a little cheat sheet.
|
||||
- [QuickRef](https://quickref.me/quickref.html): This is the magic syntax variant manual that you can use on QuickRef.ME, It's a good practice for contributors.
|
||||
- [MIME types](https://quickref.me/mime.html): This cheat sheet lists some common MIME types for the Web. You can look in the [IANA/MIME Media Types registry](http://www.iana.org/assignments/media-types/index.html) which contains all registered MIME types.
|
||||
|
||||
</details>
|
||||
|
||||
|
||||
|
||||
## 🗂️ Directory structure
|
||||
```
|
||||
.
|
||||
├── source
|
||||
@@ -44,24 +235,26 @@ Read the cheatsheet gracefully https://quickref.me
|
||||
└── coo # Theme files
|
||||
```
|
||||
|
||||
## Contributing
|
||||
|
||||
Thanks for your interest on contributing to reference, it's people like you that make [QuickRef.ME](https://quickref.me) such a amazing site 🎉🎉. Feel free to [submit issues](https://github.com/Fechin/reference/issues/new?assignee=Fechin) and enhancement requests.
|
||||
|
||||
**It's a good practice to refer to the cheatsheet of the [QuickRef Cheatsheet](https://quickref.me/quickref)**.
|
||||
|
||||
|
||||
### Development setup
|
||||
|
||||
## 🤝 Contributing
|
||||
|
||||
We would like to extend our gratitude to you for considering a contribution to Reference. Your support is what makes QuickRef.ME a truly amazing resource. Please feel free to [submit issues](https://github.com/Fechin/reference/issues/new?assignee=Fechin) and enhancement requests.
|
||||
|
||||
For consistency, we encourage you to refer to the [https://quickref.me/quickref](https://quickref.me/quickref) when creating or editing cheatsheets. 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](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm))
|
||||
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.
|
||||
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:
|
||||
|
||||
A `source/_posts/{filename}.md` file will be processed into a cheat sheet, let's create or edit a markdown file:
|
||||
|
||||
### Front Matter
|
||||
```markdown
|
||||
---
|
||||
title: QuickRef
|
||||
@@ -74,10 +267,7 @@ categories:
|
||||
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](https://github.com/arve0/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
|
||||
Only the `title` and `intro` fields are required, and the other options can be left blank.
|
||||
|
||||
|
||||
<a href="https://github.com/Fechin/reference/graphs/contributors">
|
||||
@@ -85,7 +275,16 @@ QuickRefs uses [markdown-it-attrs](https://github.com/arve0/markdown-it-attrs) a
|
||||
</a>
|
||||
|
||||
|
||||
## 🐦 Follow us on Twitter
|
||||
|
||||
## License
|
||||
[MIT](https://github.com/Fechin/reference/blob/main/LICENSE) © [Fechin](https://github.com/Fechin)
|
||||
[](https://twitter.com/FechinLi)
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
|
||||
## 📃 License
|
||||
|
||||
The project is licensed under the [MIT](https://github.com/Fechin/reference/blob/main/LICENSE) License and is maintained by [Fechin](https://github.com/Fechin).
|
||||
|
||||
Reference in new issue
Block a user