Docs / Writing diagrams
Markdown and icons
Bold, code, links and icons work almost everywhere you can write text.
On this page
Text in messages, notes, dividers, delays and section labels can be formatted with a small, safe subset of Markdown, and can include icons.
Inline formatting
| Write | Get |
|---|---|
**bold** or __bold__ | bold |
*italic* or _italic_ | italic |
~~struck~~ | |
code | code |
[a link](https://example.com) | a link |
Client -> API: `POST /orders` with an **idempotency key**
note: See the [API reference](https://example.com/docs) for *every* field.Use a backslash to write a character that would otherwise start formatting, such as \*.
Links can point to web pages (https:), email addresses (mailto:) and relative paths. Other kinds of link, such as javascript:, are shown as plain text.
Blocks in multi-line notes
A multi-line note also takes paragraphs (separated by a blank line), bulleted lists with - or *, numbered lists with 1., and fenced code blocks.
note Client, API:
Retries are safe because:
- the key is unique per order
- the API stores the first response for 24 hours
```
Idempotency-Key: order-42
```Icons
Volley includes the free Font Awesome 5 icons. Write an icon in braces: a style letter, a dash and the icon's name.
| Style | Form | Example |
|---|---|---|
| Solid | {fas-name} | {fas-database}, {fas-key}, {fas-bolt} |
| Regular | {far-name} | {far-clock}, {far-envelope} |
| Brands | {fab-name} | {fab-github}, {fab-stripe}, {fab-slack} |
| Light | {fal-name} | Falls back to regular or solid |
| Duotone | {fad-name} | Falls back to solid or regular |
Add fa-lg after the name to draw it larger: {fas-lock fa-lg}.
Browser -> API: Sign in
...: Token expires
API ->> Slack: Post an alert- Find icon names in the Font Awesome 5 free gallery. Use the name without the
fa-prefix. - If the requested style does not have the icon, Volley tries the other styles. If no style has it, a
?marks the spot so you can fix the name. - Icons appear in the editor, the viewer and interactive embeds. Downloaded SVG images and README embeds leave them out, so do not rely on an icon alone to carry meaning.