Syntax for assets comments

Titles

To create a title, start the line with one or many # (number sign).

Level 1 title

Markdown: # Level 1 title

Level 2 title

Markdown: ## Level 2 title

Level 3 title

Markdown: ### Level 3 title

Level 4 title

Markdown: #### Level 4 title

Level 5 title

Markdown: ##### Level 5 title

Level 6 title

Markdown: ###### Level 6 title

Text formatting

Bold

To bold text, add two asterisks or underscores before and after a word or phrase. To bold the middle of a word for emphasis, add two asterisks without spaces around the letters.

Markdown:

I love **bold**

Render:
I love bold

Markdown:

A**gra**ph

Render:
Agraph

Emphase

To emphasize text, add one asterisk or underscore before and after a word or phrase. To italicize the middle of a word for emphasis, add one asterisk without spaces around the letters.

Holidays in *Italy*

Render:
Holidays in Italy

Hol*Italy*days

Render:
HolItalydays

bold and emphase

To emphase and bold text at the same time, add three asterisks or underscores before and after a word or phrase. To bold and italicize the middle of a word for emphasis, add three asterisks without spaces around the letters.

***Bold holidays in Italy***

Render:
Bold holidays in Italy

___Bold holidays in Italy

Render:
___Bold holidays in Italy

Holidays***bolditaly***in

Render:
Holidaysbolditalyin

Strike-through

To strike through a text add ~ before and after it.

~Error~

Render:
Error

Code

Line

To denote a word or phrase as code, enclose it in back-ticks `.

`echo "toto"`

Render: echo "toto"

Code blocks

To create code blocks, fence it between three back-ticks

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

Render:

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

Lists

Ordered lists

To create an ordered list, add line items with numbers followed by periods.

1. First
2. Second
3. Third
4. Fourth

Render:

  1. First
  2. Second
  3. Third
  4. Fourth
1. First
    1. Sub-First
1. Second
1. Third

Render:

  1. First
    1. Sub-First
  2. Second
  3. Third

Unordered lists

To create an unordered list, add -, * or + in front of line items.

- First
    - Sub-First
- Third
- Fourth

Render:

  • First
    • Sub-First
  • Third
  • Fourth

To create a link, enclose the link text in brackets [] and then follow it immediately with the URL in parentheses ().

Go to [Cyberwatch](https://cyberwatch.fr)

Render:
Go to Cyberwatch

Back to top