Markdown
ELI5 — The Vibe Check
Markdown is a simple way to format text using just plain characters. Put **asterisks** around a word and it becomes bold. Add a # at the start and it becomes a heading. GitHub, Notion, and basically everything on the internet renders Markdown.
Real Talk
Markdown is a lightweight markup language with plain-text formatting syntax that converts to HTML. Created by John Gruber in 2004, it is the standard format for README files, wikis, issue comments, and technical documentation.
Show Me The Code
# Heading 1
## Heading 2
**bold** and *italic*
- list item
- another item
`inline code`
```js
console.log("code block");
## When You'll Hear This
"Write the PR description in Markdown." / "The docs site is generated from Markdown files."
Related Terms
Documentation
Documentation is written explanation of how your code works and why.
Gist
A Gist is a GitHub feature for sharing a single file or small snippet of code publicly (or privately).
README (README)
A README is the instruction manual taped to the front of a code project. It tells newcomers what the project does, how to install it, and how to use it.
YAML (YAML)
YAML is a way to write structured data that actually looks like a human wrote it.