Skip to main content

Shortcode Gallery

Reference for supported content shortcodes, visual helpers, and migration syntax

Copy/Save

Shortcode Gallery

This page documents the authoring helpers available in the Astro docs site. Use native Markdown when it meets the need; reach for shortcodes when you need styled UI components.


Text formatting

**Bold text**, *italic text*, and ~~strikethrough text~~.

Use `inline code` for UI labels, API parameters, and literal values.

Press <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> to open the command palette.

Bold text, italic text, and strikethrough text.

Use inline code for UI labels, API parameters, and literal values.

Press Ctrl + Shift + P to open the command palette.


Visit the [Soracom User Console](https://console.soracom.io) or see the [API reference](/api-reference).

![Soracom logo](/images/soracom-logo.svg)

Visit the Soracom User Console or see the API reference.

Soracom logo

Blockquotes

> Connectivity is the foundation of IoT. Without reliable data transfer,
> even the best sensors are just expensive paperweights.

Connectivity is the foundation of IoT. Without reliable data transfer, even the best sensors are just expensive paperweights.


Lists

- Activate your SIM
- Register the device
- Configure the group

1. Log in to the User Console
2. Navigate to SIM Management
3. Click **Register SIM**

- [x] Create account
- [x] Order SIM
- [ ] Activate SIM
- [ ] Connect device
  • Activate your SIM
  • Register the device
  • Configure the group
  1. Log in to the User Console
  2. Navigate to SIM Management
  3. Click Register SIM
  • Create account
  • Order SIM
  • Activate SIM
  • Connect device

Tables

| Plan        | Data rate       | Region |
|-------------|-----------------|--------|
| plan01s     | Up to 2 Mbps    | Global |
| plan01s-LDV | Low data volume | Global |
| planArc01   | Varies          | Global |
PlanData rateRegion
plan01sUp to 2 MbpsGlobal
plan01s-LDVLow data volumeGlobal
planArc01VariesGlobal

Horizontal rules

Content above the rule.

---

Content below the rule.

Content above the rule.


Content below the rule.


Callouts

Use directive ::: callout syntax for info, warning, and alert notices:

:::info
Info notice for helpful context.
:::

:::warning
Warning for content that needs extra attention.
:::

:::alert
Critical information that must not be missed.
:::

Info notice for helpful context.

Warning for content that needs extra attention.

Critical information that must not be missed.


Code blocks

```bash
soracom --version
```
soracom --version

Mermaid diagrams


Glossary tooltips


Callouts (semantic)


Annotation


Tabs

For short, parallel alternatives (regions, languages, small variants). If content scrolls, prefer a dedicated section.

::::tabs
:::tab{label="Overview"}
This content is in the first tab.
:::
:::tab{label="Details"}
This content is in the second tab.
:::
::::

This content is in the first tab.

This content is in the second tab.


Code example

Inline output

Remote GitHub source


Advanced tables


Prerequisites and limitations


Release phase notice


Browser frame


Image frame


YouTube embed


Carousels


Badges


Icons





API expansion controls


Page break


Support inquiry CTA


Zendesk FAQ embed


Demo pair

For showing Usage/Rendered or Before/After pairs inside a single demo card on any content page.

```md preview
:::info
Info notice for helpful context.
:::
```
:::info
Info notice for helpful context.
:::

Info notice for helpful context.

Search Esc to close / Enter to view results