דלג לתוכן הראשי

Markdown Basics

Markdown is a lightweight markup language that allows you to format text using plain text syntax. Most Markdown processors support the basic syntax defined in the original design document, with slight variations.

Headings​

Use # for headings. The number of # symbols corresponds to the heading level:

# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6

Alternate syntax (for h1 and h2 only):

Heading 1
=========

Heading 2
---------

Best Practices:

  • Always add a space between # and the heading text.
  • Add a blank line before and after a heading.

Paragraphs​

Separate paragraphs with a blank line:

This is the first paragraph.

This is the second paragraph.

Avoid:

    This is indented and may not render as expected.

Line Breaks​

End a line with two or more spaces or use <br>:

This is the first line.  
This is the second line.

This is another line.<br>
And this continues.

Emphasis​

Bold:

**bold**
__bold__

Italic:

*italic*
_italic_

Bold + Italic:

***bold and italic***
__*bold and italic*__

Blockquotes​

Use > for blockquotes:

> This is a quote.

Nested quote:

> First level
>> Second level

Include elements like lists or headings inside blockquotes:

> #### Title
> - Point one
> - Point two

Lists​

Ordered List​

1. First
2. Second
3. Third

Nested:

1. Item
    1. Subitem

Unordered List​

- Item
* Item
+ Item

Nested:

- Item
    - Subitem

Start list items with numbers? Escape the period:

- 1968\. A great year

Code​

Inline:

Use the `code` keyword.

Block (indented):

    <html>
        <head></head>
    </html>

Fenced block (preferred):

<html>
    <head></head>
</html>

Horizontal Rules​

***
---
___
[Link text](https://example.com)

[Link text](https://example.com "Optional title")

Auto-link:

<https://example.com>
<[email protected]>

Reference-style:

[example][1]

[1]: https://example.com "Optional title"

Images​

![Alt text](/path/to/image.jpg "Optional title")

Linked image:

[![Alt text](/path/to/image.jpg)](https://example.com)

Escaping Characters​

Use a backslash (\) to escape special characters:

\* not italic
\_ not italic

Characters that can be escaped include: \, `, *, _, {}, [], (), #, +, -, ., !, |

HTML in Markdown​

You can use HTML directly:

<strong>Bold text</strong>
<em>Italic text</em>

Note: Some Markdown engines may restrict HTML tags for security. Always test your document if using raw HTML.