Markdown

Last modified by Kevin Kaluza on 02.08.2021, 13:01

This wiki site describes the current support of markdown within PIM, based on this markdown guide.

It also provides examples of how to format text with markdown.

Currently supported elements

  • Headings (H1-H6)
  • Strikethrough, Bold, Italic
  • Paragraph
  • Line breaks
  • Blockquote
  • Horizontal Line
  • Ordered and unordered lists
  • Table, Alignment
  • Code
  • Link
  • Fenced Code Block
  • Heading-ID
  • Adding images from url
  • Codeblock
  • Url & e-mail adress
  • Escaping characters

Examples of markdown formatting

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

**Bold text**, _Italic text_, ~~strikethrough~~

* unordered list point 1
* unordered list point 2

1. ordered list item 1
2. ordered list item 2

> blockquote

Horizontal Line
***
---
_________________

This is the first line.  
And this is the second line.  
Note the two spaces at the end for a line break.


I really like using Markdown.

New paragraph: I think I'll use it to format all of my documents from now on.


Table:
| Syntax | Description |
| ----------- | ----------- |
| Header | Title |
| Paragraph | Text |

Alignment:
| Syntax      | Description | Test Text     |
| :---        |    :----:   |          ---: |
| Header      | Title       | Here's this   |
| Paragraph   | Text        | And more      |

`code`

[test-link](https://www.google.de)

Fenced-Codeblock:
```
{
  "firstName": "John",
  "lastName": "Smith",
  "age": 25
}
```

### My Great Heading {#custom-id}

![Test](https://upload.com/testimage.jpg)

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

<https://www.markdownguide.org>
<fake@example.com>

\* Without the backslash, this would be a bullet in an unordered list.

[Link to the heading ID](#custom-id)

Currently unsupported

  • Footnote
  • Task List
  • Definition List
  • Syntax Highlighting
  • Adding Images from root
Tags: