Comentario allows to write comments with rich formatting by using the so-called Markdown format (or language).

Markdown is a lightweight markup language that allows you to format plain text in a simple and easy-to-read way. It is widely used for writing documentation, creating README files, and even writing blog posts. Markdown files typically have a .md extension.

Markdown provides a set of syntax rules that you can use to format your text. Below are some basic examples of Markdown formatting.

Emphasis

Put asterisks around text to make it bold or italic:

*Italic text*
**Bold text**

Result:

Strikethrough

Put two tildes on both sides of text to make it stricken out:

~~I really mean that~~

Result:

Lists

Use asterisks or numbers ending with a dot to make a list:

* First item
* Second item
* Third item

Result:

1. First item
2. Second item
3. Third item

Result:

Links

You can simply insert a plain URL to turn it into a clickable link. If you want to use custom link text, format the link as follows:

[Link text](https://www.example.com)

Result:

Images

![Alt text](path/to/image.png)

Result:

Code blocks

```python
def hello_world():
    print("Hello, World!")
```

Result:

def hello_world():
    print("Hello, World!")

Blockquotes

> This is a blockquote.

Result:

Tables

| Column 1 | Column 2 |
|----------|----------|
| Cell A   | Cell B   |

Result:

Headings

# Heading 1
## Heading 2
### Heading 3

Result:

These are just a few examples of Markdown syntax. Markdown is highly versatile and supports many other formatting options. It’s a great way to write and format text without the need for complex HTML or other markup languages.

See also

• Comment
• Comment Editor