Working with Markdown

Edit this page on Github

This posts contains useful markdown syntax that will help you some time in the future. The examples are not displayed in HTML but Markdown because I use ~~~ around them.

Headings

1
2
3
# h1 heading
## h2 heading
### h3 heading

Bold and italics

1
2
**This text is bold**
*And this italics*

Special formatting

Use special formatting when the need arises:

1
2
3
- ~~strike through this text~~
- ==highlight this text== text
- \*escaped characters in this text instead showing text in italics\*
1
[this is a link](to this file or URL)

Images

1
![this is the alt text](for the image in this location)

Writing code blocks

You can insert two types of code elements in Markdown:

  • Inline code within a line of text: Wrap any word or words in back-ticks (`):

    1
    
      Create a `code snippet` like this.
    
  • Larger code snippets in code blocks: Use triple back ticks (```)

    1
    2
    3
    4
    5
    
      ```
      .my-link {
          text-decoration: underline;
      }
      ```
    

You can implement code highlighting for different languages, for example HTML:

HTML:

1
2
3
4
5
6
7
```html
<li class="ml-1 mr-1">
    <a target="_blank" href="#">
    <i class="fab fa-twitter"></i>
    </a>
</li>
```

Send feedback!