Markdown
You can use Markdown in most fields where you enter text in DiffBench. There are some places where you can't use all Markdown syntax — for example, you can't use bulleted list syntax inside an issue title — but the following describes the basic building blocks of syntax that you can use in most places.
Inline content
-
Italics:
_italics_or*italics*(example) -
Bold:
**bold**(example) - Code:
`code`(example) -
Strikethrough:
~strikethrough~(example) -
Links:
[link text](https://example.com/)(example)
Block-level content
Blockquotes
> Blockquoted content.
Renders as:
Blockquoted content.
Fenced code blocks
```
// An example code block.
```
Renders as:
// An example code block.
You can also explicitly indicate the language that appear in the code block:
```typescript
console.log('Hello, world.');
```
Renders as:
console.log('Hello, world.');
Bulleted lists
- First.
- Second.
Renders as:
- First.
- Second.
Numbered lists
1. First.
2. Second.
Renders as:
- First.
- Second.
Horizontal rules
---
Renders as:
Extensions
Tables
| Header | Header |
| ------- | ------- |
| Content | Content |
| Content | Content |
Renders as:
| Header | Header |
|---|---|
| Content | Content |
| Content | Content |
Definition lists
First term
: Details for the **first term**
Second term
: Details for the **second term**
More details in second paragraph.
Renders as:
- First term
-
Details for the first term
- Second term
-
Details for the second term
More details in second paragraph.
Task lists
- [ ] In progress
- [x] Done
Renders as:
- In progress
- Done
Alerts
> [!NOTE]
> Something noteworthy.
> [!TIP]
> A tip.
> [!IMPORTANT]
> Important information.
> [!WARNING]
> A warning.
> [!CAUTION]
> A caution.
Renders as:
Note
Something noteworthy.
Tip
A tip.
Important
Important information.
Warning
A warning.
Caution
A caution.
Footnotes
Text[^1]. More text[^text].
[^1]: First footnote.
[^text]: Second footnote.
Renders as: