Skip to content

Instantly share code, notes, and snippets.

@DJStompZone
Created April 19, 2023 21:45
Show Gist options
  • Save DJStompZone/c8eb90879e711659fd63be3fc3eba492 to your computer and use it in GitHub Desktop.
Save DJStompZone/c8eb90879e711659fd63be3fc3eba492 to your computer and use it in GitHub Desktop.
Markdown crash course

Markdown

"It's easier than it looks!"

  • Famous Last Words

So... You want to write a README?

Let's go over the basics


Headers

  • H1

  • H2

  • H3

  • H4

Text

  • *Italic text*
  • **Bold text**
  • **Bold *italic* text**

Lists

Links

[Text](URL) -> Text

Code

Inline code (single backticks)

<p>Long-form code block (Triple backticks)</p>

Done!

Now you can make a README! There's plenty more to learn, but that's enough to make a perfectly passable README.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment