Markdown Help
Using the editor
Use Markdown when writing a topic, answer, reply, or chat message. The formatting buttons above the editor insert the characters for you, or you can type them yourself. Select text before using a button to format that text.
Where a preview is available, check it before posting to see how your formatting will look. Upload images with the editor's image button; the upload inserts the appropriate Markdown into your text.
Markdown
To format your text so that it is easier for others to read, please use markdown. Markdown is simple, straightforward, and writes in a natural manner. With markdown you can make bold and italic text, different levels of headings, lists, blockquotes, and links. You can also upload images to show in your body of text. You can format code inline or in blocks, with the option to specify the language for syntax highlighting.
Bold
To make text bold add two asterisks before and after the text. The rendered output will include strong tags around this text.
| Markdown | Rendered Output |
|---|---|
| There is **bold text** in this sentence | There is bold text in this sentence |
Italic
To make text italic add one asterisk before and after the text. The rendered output will include em tags around this text.
| Markdown | Rendered Output |
|---|---|
| There is *italic text* in this sentence | There is italic text in this sentence |
Bold and Italic
You can also combine both bold and italic. To do this add three asterisks before and after the text. The rendered output will include both strong and em tags around this text.
| Markdown | Rendered Output |
|---|---|
| There is ***bold italic text*** in this sentence | There is italic text in this sentence |
Headings
To create a heading, put one or more hash characters followed by a space at the beginning of a line.
Use # for your main sections and
## for subsections. Ozzu reserves the top heading level for
the topic title, so these render as second- and third-level headings.
| Markdown | Rendered Output |
|---|---|
| # Heading level 1 | Heading level 1 |
| ## Heading level 2 | Heading level 2 |
Lists
With markdown you can also create both ordered and unordered lists simply and easily.
Ordered Lists
To create an ordered list simply write each line beginning with a number and a period. This will then automatically be converted to an ordered list with the first line using the number 1 and each line incrementing by 1.
| Markdown | Rendered Output |
|---|---|
| 1. First Item 2. Second Item 3. Third Item |
|
Unordered Lists
You can also create unordered lists by creating multiple lines with each one prefixed by an asterisks.
| Markdown | Rendered Output |
|---|---|
| * First Item * Second Item * Third Item |
|
Blockquotes
You can create a block of quoted text by using a syntax similar to how e-mails show quoted text. To enable quoted text put a greater-than sign and a space before the text you want to quote. You can quote multiple lines by having each line of text starting with another greater-than sign.
| Markdown | Rendered Output |
|---|---|
| > Some quoted text |
|
| > Some quoted text > that exist on > multiple lines |
|
Inline Code
You can also use inline code in your text by putting a backtick before and after the text that represents a piece of code. You should only use this for small pieces of code that do not span multiple lines. This will enable the code to standout in your text and make it clear that you are referring to code.
| Markdown | Rendered Output |
|---|---|
| This `$var` is inline |
This $var is inline
|
Code Blocks
To create blocks of code use three backticks followed by a newline to denote the beginning of your code, and then three backticks followed by a newline to denote the end of your code. You can also specify the language you are utilizing by putting the name after the first three tick marks. Regardless of if you specify a language or not, our syntax highlighting engine will do its best to colorize parts of your code. See the examples below:
| Markdown | Rendered Output |
|---|---|
| ``` $var = 'A code block'; ``` |
|
| ```php $var = 'A code block'; ``` |
|
Links
There are two types of links: those that are automatically parsed, and links you specify with anchor text.
If you post any full urls which include the https:// portion, those will be automatically turned into
links. Otherwise to create a link with specified anchor text, put your anchor text in brackets and then
follow that with your URL enclosed in parenthesis. See the examples below:
| Markdown | Rendered Output |
|---|---|
| Automatically linked: https://www.ozzu.com/ | Automatically linked: https://www.ozzu.com/ |
| This [text](https://www.ozzu.com/) is linked to Ozzu | This text is linked to Ozzu |
Posting tips
- Leave a blank line before and after lists, quotes, and code blocks to keep sections separate.
- Use descriptive headings and link text so readers know what each section or link contains.
- Paste code as text in a code block rather than uploading a screenshot of it.
- Use inline code for short names, commands, or values within a sentence.
- Raw HTML is displayed as text. Use the Markdown examples above to format your post.