Markdown Overview
If you’re familiar with GitHub, Slack, or Discord markdown, very similar syntax is used on our forums. If “markdown” sounds more like a dance move than a format, then consider checking out the following resources to get up to speed on the syntax.
Brief Markdown Cheatsheet
Headers
# Header1
## Header2
### Header3
#### Header4
##### Header5
###### Header6
Headers Preview
Header1
Header2
Header3
Header4
Header5
Header6
Font Styling
Emphasis, aka italics, with *asterisks* or _underscores_.
Strong emphasis, aka bold, with **asterisks** or __underscores__.
Combined emphasis with **asterisks and _underscores_**.
Strikethrough uses two tildes. ~~Scratch this.~~
Font Styling Preview
Emphasis, aka italics, with asterisks or underscores.
Strong emphasis, aka bold, with asterisks or underscores.
Combined emphasis with asterisks and underscores.
Strikethrough uses two tildes. Scratch this.
Ordered and Unordered Lists
1. First ordered list item
2. Another item
* Unordered sub-list.
1. Actual numbers don't matter, just that it's a number
1. Ordered sub-list
4. And another item.
* Unordered lists can use asterisks
- A hyphens
+ Or a plus
Ordered and Unordered Lists Preview
- First ordered list item
- Another item
- Unordered sub-list.
- Actual numbers don’t matter, just that it’s a number
- Ordered sub-list
- And another item.
- Unordered lists can use asterisks
- A hyphens
- Or a plus
Hyperlink Text
[Inline-style link](https://ultralytics.com)
[Inline-style link + Title (hover to view title)](https://github.com/ultralytics "Ultralytics GitHub Organization")
Hyperlink Text Preview
Inline-style link + Title (hover to view title)
Inline Code
Inline `code` uses a single backtick ( \` ) character surrounding the content, but can also be escaped to view using a backslash `\` character.
Inline Code Preview
Inline code uses a single backtick ( ` ) character surrounding the content, but can also be escaped to view using a backslash \ character.
Code Block
Three backticks ``` can be used to “fence” off a block of code, and is sometimes referred to as “code-fencing.” It’s also possible to enable syntax highlighting using an appropriate alias.
```python
from ultralytics import YOLO
model = YOLO("yolov8n.pt")
results = model.predict("ultralytics/assets/bus.jpg")
for result in results:
print(results.boxes.data)
```
Code Block preview
from ultralytics import YOLO
model = YOLO("yolov8n.pt")
results = model.predict("ultralytics/assets/bus.jpg")
for result in results:
print(results.boxes.data)
Tables
Use the pipe character | to create a table, but you must include a row to denote the headers from the row-content, usually using hyphens - but can also include a colon : to specify the column alignment. It is not necessary to align columns, but it can make edits easier, and the same is true for spacing around a pipe| character.
| Col-1 | Col-2 | Col-3 |
| :---- | :----: | ----: |
| Left | Center | Right |
| 2nd | Other | This |
NOTE text here is shown aligned due to mono-spacing, but would not appear aligned in the message window.
Table preview
| Col-1 | Col-2 | Col-3 |
|---|---|---|
| Left | Center | Right |
| 2nd | Other | This |
Block Quotes
> Blockquotes are helpful to denote a reply to specific text.
> This line is part of the same quote.
Quote break.
> Oh yeah, you can also *use* markdown __formatting__ in a `blockquote`. This is a very long line that will still be quoted properly when it wraps. Oh boy let's keep this going to make sure it's extra long enough to line wrap for everyone reading.
Block Quote Preview
Blockquotes are helpful to denote a reply to specific text.
This line is part of the same quote.
Quote break.
Oh yeah, you can also use markdown formatting in a
blockquote. This is a very long line that will still be quoted properly when it wraps. Oh boy let’s keep this going to make sure it’s extra long enough to line wrap for everyone reading.