Frankenguide — Format Reference

Objective

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam vehicula augue sit amet libero fringilla, nec auctor magna pretium. This guide compiles every supported format so that a single visual pass can confirm nothing is broken after a theme or build change.

Requirements

• An OVHcloud account with access to the Control Panel
• Basic familiarity with Markdown and MDX
• A browser to verify that all formats render correctly

Instructions

1 — Plain text and inline formatting

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque habitant morbi tristique senectus. Use inline code to reference technical terms, file paths like /etc/hosts, or commands like sudo systemctl restart nginx.

You can also combine them: bold code or italic code.

Superscript for footnotes¹ and line breaks
between phrases are also supported.

¹ This is a simulated footnote rendered with superscript HTML.

Tooltip example: hover over this wordThis is a tooltip with inline code and a link. to see the overlay.

2 — Headings

H4 — Fourth-level heading

H5 — Fifth-level heading (use sparingly)

3 — Images

Image from the shared public folder (referenced by absolute path, shared across all locales):

Second image from a different guide folder (still a shared public asset):

4 — Code blocks

Bash:

#!/bin/bash
# Create and mount a logical volume for SAP HANA data
pvcreate /dev/sdb
vgcreate vg_hana /dev/sdb
lvcreate -L 500G -n lv_hanadata vg_hana
mkfs.xfs /dev/vg_hana/lv_hanadata
mount /dev/vg_hana/lv_hanadata /hana/data
echo "Mount successful"

Console (interactive shell output):

$ lsblk
NAME          MAJ:MIN RM   SIZE RO TYPE  MOUNTPOINT
sda             8:0    0 447.1G  0 disk
├─sda1          8:1    0   512M  0 part  /boot/efi
├─sda2          8:2    0     1G  0 part  /boot
└─sda3          8:3    0 445.6G  0 part
  └─md0         9:0    0 445.6G  0 raid1 /
sdb             8:16   0  10.5T  0 disk

$ df -h /hana/data
Filesystem                       Size  Used Avail Use% Mounted on
/dev/mapper/vg_hana-lv_hanadata  500G  1.2G  499G   1% /hana/data

JSON:

{
  "serviceName": "pcc-1-2-3-4",
  "ram": 512,
  "storage": {
    "type": "NVMe",
    "sizeGb": 10240
  },
  "tags": ["production", "sap-hana"]
}

YAML:

version: "3.8"
services:
  app:
    image: nginx:latest
    ports:
      - "80:80"
    volumes:
      - ./html:/usr/share/nginx/html:ro

5 — Callouts

Empty blockquote (plain > syntax, no type annotation):

Lorem ipsum dolor sit amet, consectetur adipiscing elit. This is an unstyled blockquote, also known as an "empty" callout.

6 — Details (collapsible sections)

echo "Hello from inside a collapsible"

7 — Tables

Simple table:

Table with HTML line breaks in cells:

8 — Lists

Unordered list:

• Lorem ipsum dolor sit amet
• Consectetur adipiscing elit
• Sed do eiusmod tempor incididunt

Nested unordered list:

• Universe level
  • Product level
    • Section level
      • Guide level (deepest nesting)
  • Another product
    • Its section

Numbered list:

1. Connect to the OVHcloud Control Panel.
2. Navigate to Bare Metal Cloud > Dedicated Servers.
3. Select your server from the list.
4. Click the Install button to launch the reinstallation wizard.
5. Confirm your choice in the modal dialog.

Numbered list with a custom start value:

6. Review the partition layout proposed by the wizard.
7. Click Confirm to finalize the installation.

9 — Links

Internal link (guide path): All about your OVHcloud username

Internal link (shortcut alias): OVHcloud Control Panel

External link: OVHcloud community forum

Link inside a sentence: To manage your SSH keys, log in to the OVHcloud Control Panel and navigate to My account > SSH keys.

Inline code outside a link: Use the --force flag only when you are certain the operation is safe.

Inline code inside a link: See the /me/api/credential endpoint reference for authentication details.

Sentence mixing both: the GET /me call returns your account details, whereas plain text links like the Control Panel do not use code formatting.

10 — API calls

Single GET call:

POST call with a path parameter:

PUT call limited to EU and CA regions:

DELETE call:

11 — Tabs

Basic tabs:

ssh ubuntu@192.0.2.1 -i ~/.ssh/my_key

ssh ubuntu@192.0.2.1 -i C:\Users\user\.ssh\my_key

12 — Embedded video

12b — Guided-tour iframe

13 — Russian-doll (nested formats)

The following tabs each contain multiple nested format types.

# /etc/hana/global.ini
[persistence]
basepath_datavolumes = /hana/data/SID
basepath_logvolumes  = /hana/log/SID

[communication]
listeninterface = .global

$ blkid /dev/vg_hana/lv_hanadata
/dev/vg_hana/lv_hanadata: UUID="a1b2c3d4-e5f6-7890-abcd-ef1234567890" TYPE="xfs"

$ grep hana /etc/fstab
UUID=a1b2c3d4-e5f6-7890-abcd-ef1234567890  /hana/data  xfs  noatime,nodiratime,logbsize=256k  0 0

14 — Russian-doll: formats inside a Details

# Replace <credentialId> with the numeric ID returned by the GET call above
curl -X DELETE "https://eu.api.ovh.com/v1/me/api/credential/<credentialId>" \
  -H "X-Ovh-Application: <appKey>" \
  -H "X-Ovh-Consumer: <consumerKey>" \
  -H "X-Ovh-Timestamp: $(date +%s)" \
  -H "X-Ovh-Signature: <signature>"

Go further

• OVHcloud API documentation
• Managing contacts for your services
• OVHcloud community forum

Join our community of users.