search

open-sauced / pizza-verse

A repository for all things pizza.
MIT License
38 stars 56 forks source link

Feature: Markdown Style reference #7

Closed CBID2 closed 1 year ago

CBID2 commented 1 year ago

Type of feature

📝 Documentation

Current behavior

Even though the ReadMe file suggests following the markdown syntax based on the other entries, contributors, especially those who never used this language before would have a hard time remembering how to format their contribution.

Suggested solution

I think it would be helpful to create some sort of Markdown reference guide. It'll make it easier for contributors, especially those who have never used Markdown before to gain a better understanding of how to format their contribution. Note: I would love to create this guide.

Additional context

No response

Code of Conduct

Contributing Docs

bdougie commented 1 year ago

This is what I learned from years ago. We can either link to it or create a quick reference guide.

https://daringfireball.net/projects/markdown/basics

Bonus: Probably worth adding a reference to where ever this lives to here: https://github.com/open-sauced/intro/blob/main/09-glossary.md

CBID2 commented 1 year ago

Hey @bdougie! :) I created the PRs! :) It's #8 in this repo and #32 in the intro repo. I don't know when @BekahHW will return, but can you review them just in case?