QuickSnip

An open-source project that categorizes handy code snippets across various programming languages. Built with love and powered by an awesome community. 🚀

How to contribute

Want to help make QuickSnip even better? You can contribute by:

Improving the Code: Fix bugs, suggest new features, or optimize the project.
Adding New Snippets: Share your favorite snippets to grow the database.

Be sure to check out the CONTRIBUTING.md file for detailed guidelines.

Improving the code

Got a feature idea or bug fix? Here's how you can contribute:

Open an issue to share your ideas or report a bug.
Send a pull request with your changes.

Adding a Snippet

The snippets database is located in the /snippets folder.

Find the relevant language folder.
Locate the appropriate category folder for your snippet.
Create a markdown file and add your snippet using the following format:

---
title: Name of the snippet
description: A short explanation of what the snippet does
tags: tag1, tag2, tag3
author: your-github-username
---

```lang
// Your code here
```

Here's an example for JavaScript:

---
title: Format Date
description: Formats a date in 'YYYY-MM-DD' format.
author: dostonnabotov
tags: javascript,date,format
---

```js
const formatDate = (date) => date.toISOString().split('T')[0];

// Usage:
console.log(formatDate(new Date())); // Output: '2024-12-10'
```

Expected file structure:

/snippets
  |- language
    |- category-name
      |- your-snippet-here.md

Please do NOT add or edit anything in /public folder. It will be used for consolidating snippets.

To test that your snippets are formatted correctly use the snippets:check script:

$ npm run snippets:check

It will return nothing if they are well formatted, otherwise it will tell you what the error is.

To preview the snippets, you need to consolidate them, use the snippets:consolidate script:

$ npm run snippets:consolidate

It will update the snippets in the /public folder, making them available to the frontend.

For more details about adding new categories or programming languages, check out the CONTRIBUTING.md file.

Guidelines for Contributions

To keep things smooth and consistent, please:

Follow the formatting rules described above.
Include all mandatory fields in the snippet.
Test your snippet to ensure it works as expected.

Following these guidelines helps me (and everyone else) review and merge your contributions faster.

License

QuickSnip is licensed under the MIT License. Feel free to use and share it as you like.

License

Mohamed-faaris/quicksnip

ErrorLooks like something went wrong!

About

Resources

License

Code of conduct

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Languages

Error
Looks like something went wrong!

Packages