Commit e9ee067

committed

Fix syntax error in guidelines

1 parent 49692f9 commit e9ee067Copy full SHA for e9ee067

File tree

2 files changed

+51

-20

lines changed

CONTRIBUTING.md
README.md

2 files changed

+51

-20

lines changed

`‎CONTRIBUTING.md‎`

Lines changed: 20 additions & 16 deletions

Original file line number	Diff line number	Diff line change
`@@ -43,49 +43,51 @@ To add a new code snippet:`
`43`	`43`
`44`	`44`	`- Use the following format to structure your snippet:`
`45`	`45`
`46`		-```md
	`46`	+````md
`47`	`47`	`---`
`48`	`48`	`title: Name of the snippet`
`49`	`49`	`description: A short explanation of what the snippet does`
`50`	`50`	`tags: tag1, tag2, tag3`
`51`	`51`	`author: your-github-username`
`52`	`52`	`---`
`53`	`53`
	`54`	+```lang
`54`	`55`	`// Your code here`
`55`	`56`	```
	`57`	+````
`56`	`58`
`57`	`59`	`Here’s an example for JavaScript:`
`58`	`60`
`59`		-```
	`61`	+````md
`60`	`62`	`---`
`61`	`63`	`title: Format Date`
`62`	`64`	`description: Formats a date in 'YYYY-MM-DD' format.`
`63`	`65`	`author: dostonnabotov`
`64`		`-tags: javascript,date,format,utility`
	`66`	`+tags: javascript,date,format`
`65`	`67`	`---`
`66`	`68`
	`69`	+```js
`67`	`70`	`const formatDate = (date) => date.toISOString().split('T')[0];`
`68`	`71`
`69`	`72`	`// Usage:`
`70`	`73`	`console.log(formatDate(new Date())); // Output: '2024年12月10日'`
`71`	`74`	```
	`75`	+````
`72`	`76`
`73`	`77`	`5. Use syntax highlighting:`
`74`	`78`	- Enclose your code with triple backticks (```).
`75`	`79`	`- Specify the language after the first set of backticks for syntax highlighting.`
`76`	`80`
`77`		`-![snippet code example in markdown file](https://github.com/user-attachments/assets/be650cfe-fd17-49e7-ae82-e1c88e30d4c9)`
`78`		`-`
`79`	`81`	`6. Test your snippet:`
`80`	`82`	`- Ensure your code runs as expected.`
`81`	`83`
`82`		`-Expected structure:`
	`84`	`+Expected file structure:`
`83`	`85`
`84`		-```txt
`85`		`-snippets`
`86`		`- \|- language`
`87`		`- \|- category`
`88`		`- \|- your-snippet-here.md`
	`86`	+```md
	`87`	`+/snippets`
	`88`	`+ \|- language`
	`89`	`+ \|- category-name`
	`90`	`+ \|- your-snippet-here.md`
`89`	`91`	```
`90`	`92`
`91`	`93`	`### Editing a Existing Snippet`
`@@ -96,7 +98,7 @@ If you’d like to refine or improve an existing snippet:`
`96`	`98`
`97`	`99`	- Include your GitHub username under the `contributors` field in the metadata section.
`98`	`100`
`99`		-```md
	`101`	+````md
`100`	`102`	`---`
`101`	`103`	`title: Name of the snippet`
`102`	`104`	`description: A short explanation of what the snippet does`
`@@ -105,8 +107,10 @@ author: original-author`
`105`	`107`	`contributors: your-github-username`
`106`	`108`	`---`
`107`	`109`
	`110`	+```
`108`	`111`	`Updated code here`
`109`	`112`	```
	`113`	+````
`110`	`114`
`111`	`115`	`2. Credit all contributors:`
`112`	`116`
`@@ -141,10 +145,10 @@ Example structure:`
`141`	`145`
`142`	`146`	```md
`143`	`147`	`/snippets`
`144`		`- \|_ python`
`145`		`- \|_ file-handling`
`146`		`- \|_ list-manipulation`
`147`		`- \|_ ....`
	`148`	`+ \|- python`
	`149`	`+ \|- file-handling`
	`150`	`+ \|- list-manipulation`
	`151`	`+ \|- ....`
`148`	`152`	```
`149`	`153`
`150`	`154`	`### Adding a New Language`

`‎README.md‎`

Lines changed: 31 additions & 4 deletions

Original file line number	Diff line number	Diff line change
`@@ -2,9 +2,11 @@`
`2`	`2`
`3`	`3`	`An open-source project that categorizes handy code snippets across various programming languages. Built with love and powered by an awesome community. 🚀`
`4`	`4`
`5`		`-<a href="https://youtu.be/BhRi7fJzPgk?si=z1sVXU7uRS0bkSEt" target="_blank" style="text-decoration: none;">`
`6`		`- <img src="https://img.shields.io/static/v1?label=&message=Watch%20on%20YouTube&labelColor=FFFFFF&color=FF0000&style=for-the-badge&logo=youtube&logoColor=FF0000" alt="Watch on YouTube" style="margin-right: 20px">`
	`5`	`+<div>`
	`6`	`+<a href="https://youtu.be/BhRi7fJzPgk?si=z1sVXU7uRS0bkSEt" target="_blank">`
	`7`	`+ <img src="https://img.shields.io/static/v1?label=&message=Watch%20on%20YouTube&labelColor=FFFFFF&color=FF0000&style=for-the-badge&logo=youtube&logoColor=FF0000" alt="Watch on YouTube">`
`7`	`8`	`</a>`
	`9`	`+<div>`
`8`	`10`
`9`	`11`	`<br>`
`10`	`12`
@@ -36,20 +38,45 @@ The snippets database is located in the `/snippets` folder.
`36`	`38`
`37`	`39`	`3. Create a markdown file and add your snippet using the following format:`
`38`	`40`
`39`		-```md
	`41`	+````md
`40`	`42`	`---`
`41`	`43`	`title: Name of the snippet`
`42`	`44`	`description: A short explanation of what the snippet does`
`43`	`45`	`tags: tag1, tag2, tag3`
`44`	`46`	`author: your-github-username`
`45`	`47`	`---`
`46`	`48`
	`49`	+```lang
`47`	`50`	`// Your code here`
`48`	`51`	```
	`52`	+````
`49`	`53`
`50`	`54`	`Here's an example for JavaScript:`
`51`	`55`
`52`		`-![code example in markdown file](https://github.com/user-attachments/assets/dba9fda3-76fe-4d92-b12a-8bc065286b90)`
	`56`	+````md
	`57`	`+---`
	`58`	`+title: Format Date`
	`59`	`+description: Formats a date in 'YYYY-MM-DD' format.`
	`60`	`+author: dostonnabotov`
	`61`	`+tags: javascript,date,format`
	`62`	`+---`
	`63`	`+`
	`64`	+```js
	`65`	`+const formatDate = (date) => date.toISOString().split('T')[0];`
	`66`	`+`
	`67`	`+// Usage:`
	`68`	`+console.log(formatDate(new Date())); // Output: '2024年12月10日'`
	`69`	+```
	`70`	+````
	`71`	`+`
	`72`	`+Expected file structure:`
	`73`	`+`
	`74`	+```md
	`75`	`+/snippets`
	`76`	`+ \|- language`
	`77`	`+ \|- category-name`
	`78`	`+ \|- your-snippet-here.md`
	`79`	+```
`53`	`80`
`54`	`81`	`For more details about adding new categories or programming languages, check out the [CONTRIBUTING.md](/CONTRIBUTING.md) file.`
`55`	`82`

0 commit comments

Comments

(0)

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Commit e9ee067

File tree

2 files changed

2 files changed

`‎CONTRIBUTING.md‎`

`‎README.md‎`

0 commit comments