Links

Styling with Markdown

How to use Markdown with Promyze
Practices descriptions support standard flavored Markdown. You can use it to format text, put some emphasis, image, links, code snippets and much more.
Editors will have an eye button on the top right corner to toggle the preview.

Quick overview of commonly used elements

Here you will find a cheat sheet of commonly used Markdown. Everything is standard with some extras to images.

Bold

some **bold text**

Italic

some *italic text*

Strikethrough

some ~~Striked words~~

Title / header

# Big Header
### Small Header

Blockquote

> some quote
> on two lines

Highlight

some `highlighted words`

Lists

1. Ordered
2. List
3. Items
- Unordered
- List
- Items
[link text](target-url)

Image

![image alt](image-source)
Image must be from https source and it will be blocked if not. Also, it is possible to format the image using the following alts.
Example: ![q2 center](https://my.img.src) -> Make the image 50% of the view and center it.
Alt
Effect
xsmall
width: 50px
small
width: 100px
medium
width: 200px
large
width: 400px
xlarge
width: 800px
width25
width: 25%
width50
width: 50%
width75
width: 75%
width100
width: 100%
center
Center the image
right
Image float right
left
Image float left

Code snippets

Snippets support syntax highlighting. Replace "typescript" on the first line by your language name.
```typescript
// some typescript code
const someCode: string = "Hello World";
```