Formatting Reference
Headings
Front matter handles the H1. Using H2 for main sections.
## Step-by-Step Instructions
Example:
Step-by-Step Instructions
Use a standard bullet '-' point list with bold text for the step title.
- **Install the required packages:**
Example:
- Install the required packages:
Tip Callout Box
Use the custom container syntax to generate an orange tip box.
::: tip
Always create a backup of your configuration file before running the script.
:::
Example:
Always create a backup of your configuration file before running the script.
Links
Creating a link is easy.
[description](url)
Example:
Highlighting words
To highlight anything use backticks.
Locate the `fastcgi_pass`
Example:
Locate the fastcgi_pass
Blockquote
Quotes
> "Everything proceeds mathematically... if someone could have a sufficient insight into the inner parts of things, he would be a prophet and would see the future in the present as in a mirror."
>
> — **Gottfried Wilhelm Leibniz**
Example:
"Everything proceeds mathematically... if someone could have a sufficient insight into the inner parts of things, he would be a prophet and would see the future in the present as in a mirror."
— Gottfried Wilhelm Leibniz
Bold Text
**Raport Repair**
Example:
Raport Repair
Notification boxes
::: info
Standard informational note. Useful for extra context or hardware specs without interrupting the main steps.
:::
::: caution
Semi-scary heads-up: double-check pinouts, backups, or target paths before running the next command.
:::
::: warning
Warning: wrong selection or voltage here can brick the device, overwrite live data, or cause downtime.
:::
Example:
Standard informational note. Useful for extra context or hardware specs without interrupting the main steps.
Semi-scary heads-up: double-check pinouts, backups, or target paths before running the next command.
Warning: wrong selection or voltage here can brick the device, overwrite live data, or cause downtime.