a computer screen with a keyboard and a box with a logo

Markdown

1 minute read

What is Markdown?

Markdown is a lightweight markup language used to format text for web and document styling, often in README files, blogs, and documentation. Created by John Gruber in 2004, Markdown is designed to be easy to read in plain text but convert seamlessly into HTML.

Here’s an overview of Markdown's key features:

  • Headings: Add # symbols before text to create headings, with more # symbols indicating a lower-level heading.
# Heading 1
## Heading 2
### Heading 3
  • Bold and Italics: Wrap text in ** or __ for bold, and * or _ for italics.
**Bold text** and *italic text*
  • Lists:
  • Unordered lists use -, +, or *.
  • Ordered lists use numbers followed by periods.
- Item 1
- Item 2

1. First item
2. Second item
  • Links: Use [link text](URL).
[OpenAI](https://www.openai.com)
  • Images: Similar to links but prefixed with an !.
![Alt text](image_url)
  • Code Blocks: Wrap inline code with backticks (`). For blocks of code, use triple backticks (```) before and after.
`inline code`
  • Code block
<pre>
// your code goes here
</pre>

Markdown is supported by many platforms, including GitHub, GitLab, and blogging tools like Jekyll and Hugo, making it a versatile choice for web-based text.

Share this article

Related Articles