mirror of
https://github.com/Fechin/reference.git
synced 2026-11-22 14:01:45 +03:00
Update README.md
This commit is contained in:
1 parent
eb387ac3c3
commit
5a8f814daf
1 file changed
+33
-25
@@ -1,28 +1,28 @@
|
||||
# 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/)
|
||||
|
||||
|
||||
|
||||
## Directory structure
|
||||
|
||||
|
||||
## 🗂️ Directory structure
|
||||
```
|
||||
.
|
||||
├── source
|
||||
@@ -44,24 +44,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 +76,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 +84,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