Markdown guide: get started with the Markdown syntax
Markdown is a lightweight and popular markup language used to format text on the web. It's designed to be easy to read and write, and it's often used for writing documentation, blog posts, and even books. With Markdown, you can add formatting elements like headings, lists, and links to your text using simple symbols and syntax. Its simplicity and versatility make it a favorite among writers, developers, and anyone who wants to create well-formatted content quickly and efficiently.
Basics
| Syntax | Result |
|---|---|
**Bold** | Bold |
*Italic* | Italic |
~~Striketrough~~ | |
`<div>Code</div>` | <div>Code</div> |
Titles
Markdown titles are defined using the # symbol. The number of # symbols you use determines the level of the title.
For example, <h1> is created using # Title 1, <h2> with ## Title 2, and so on, up to <h6> with ###### Title 6.
Advanced formating
Tables
Markdown tables are a way to display data in rows and columns. They are created using hyphens and pipes to define the structure of the table. Here's an example of how to create a table in Markdown:
| Header 1 | Header 2 |
| -------- | -------- |
| Row 1, Col 1 | Row 1, Col 2 |
| Row 2, Col 1 | Row 2, Col 2 |
And the resulting table:
| Header 1 | Header 2 |
|---|---|
| Row 1, Col 1 | Row 1, Col 2 |
| Row 2, Col 1 | Row 2, Col 2 |
Code blocks
Markdown code blocks are used to display code snippets or blocks of code within a document. They are typically denoted by triple backticks (```) before and after the code. Code blocks are useful for sharing code examples or demonstrating programming concepts.
You can also specify the coding language, which enables syntax highlighting if the rendering software you are using has this feature.
Here's an example of a code block containing HTML code:
```html
<!DOCTYPE html>
<html>
<head>
<title>HTML Example</title>
</head>
<body>
<h1>Hello, world!</h1>
<p>This is a paragraph.</p>
</body>
</html>
```
Images
Markdown allows you to embed images in your content using a simple syntax. To add an image, you can use the following format: . The "Alt text" is a brief description of the image, which is important for accessibility and SEO. The "image-url" is the URL of the image you want to display.
Links
Markdown allows you to create hyperlinks to other web pages or resources using a simple syntax. Links are created using the following format: [Link text](URL). The "Link text" is the text that will be displayed as the hyperlink, and the "URL" is the destination address.
[Visit my website](https://my-website-url.tld)
Blockquotes
Markdown blockquotes are used to attribute a particular quotation. They are rendered with an indentation and are often used to highlight important text. To create a blockquote, you can use the > symbol followed by the text you want to quote.
> Lorem ipsum dolor sit amet, consectetur adipiscing elit.
>
> Sed non risus. Suspendisse lectus tortor, dignissim sit amet, adipiscing nec, ultricies sed, dolor.
>
> Cras elementum ultrices diam.
This example will render like this:
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
Sed non risus. Suspendisse lectus tortor, dignissim sit amet, adipiscing nec, ultricies sed, dolor.
Cras elementum ultrices diam.
