Markdown Syntax

There is a newer version of this page. You can find it here.

Format

Italic / bold

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

Preformatted Text

~~~
IF xTrue THEN
    // Especially useful for code ;)
END_IF
~~~

Unordered List

* Item 1
    * Item 1.1
    * Item 1.2
* Item 2

Check List

* [ ] Unchecked item
* [x] Checked item
    * [ ] Subitem

Headers

# Header 1
## Sub-Header
### Sub-Sub-Header
# Header 2

Horizontal rule

Here comes a horizontal rule:

---
This text comes after the rule.

Links

Implicit

Most links are detected within the text:

https://www.google.com
you@somewhere.com

Explicit

To be explicit, just add brackets around it:

<https://www.google.com>
<you@somewhere.com>

To define your own link text:

Click [here](https://www.google.com)

Relative links to headings on the same page can be realized with named links and a hash:

Jump to the [prerequisites](#prerequisite-packages)
...

# Prerequisite Packages
...

The name of the heading anchor is the name of the heading in lower case and with dashes instead of spaces.

Artifacts

You can link other tools, pages, tickets, ...

Simple

[MyWikiPage]       # Wiki - name of wiki page
[#123]             # Tracker - ticket number
[bugs:#1]          # Tracker - explicit tool selection
[r10721]           # SVN - revision number
[3b9d48]           # Git & Mercurial - first 6 characters of revision hash
[2012/02/my-post]  # Blog - post slug, including YYYY/MM/ prefix
[a6d38f98]         # Discussion Thread - thread id
[a6d38f98#42f8]    # Discussion Post - thread_id#post_id

External

[projectname:wiki:Home]
[projectname:code:3b9d48]

User Mention

@Username

Images

Standard

[[img src=attached-image.jpg]]

Resize image

[[img src=attached-image.jpg width=50%]]

Videos

[[embed url=https://www.youtube.com/watch?v=UvH572rz1Ng]]

Tables

First Header  | Second Header
  ------------- | -------------
  Content Cell  | Content Cell
  Content Cell  | Content Cell

More macros

Download button

[[download url=https://forge.codesys.com/...]]
[[download url=https://forge.codesys.com/... label=installer]]

CI/CD Badges

[[drone]]

Neighborhood Notifications

[[neighborhood_feeds tool_name=wiki max_number=10 sort=pubdate]]

Neighborhood Blog Posts

[[neighborhood_blog_posts max_number=10 sort=timestamp]]

Project Blog Posts

[[project_blog_posts max_number=10 sort=timestamp mount_point=news]]

Project Member List

[[members]]

Project Screenshots

[[project_screenshots]]