Confluence wiki markup guide
Markdown Runbook to Confluence
Convert a Markdown runbook into Confluence wiki markup with steps, warnings, code blocks, and rollback notes.
Direct answer
To move a Markdown runbook into Confluence, keep the runbook organized around purpose, pre-checks, procedure, rollback, and verification, then convert headings, ordered steps, code fences, tables, and warning notes into Confluence wiki markup.
Open Markdown to Confluence converterWhen to use this
- A deploy, rollback, or support runbook starts in Markdown.
- The final operational document needs to live in Confluence.
- The runbook includes shell commands, warnings, links, or step tables.
Steps
- Use one top-level runbook title.
- Split the page into pre-checks, procedure, rollback, and verification sections.
- Put shell commands in fenced code blocks with a language name.
- Use blockquotes that start with Warning, Note, Info, or Tip for Confluence macros.
- Convert the Markdown to Confluence wiki markup and preview the page after pasting.
Example conversion
Markdown input
## Deploy runbook > Warning: Confirm the release owner is online before starting. ### Pre-checks - Confirm staging passed - Confirm the feature flag is enabled - Confirm support is aware ### Deploy ```bash npm run build npm run deploy ``` ### Rollback 1. Open the deploy dashboard 2. Select the previous version 3. Confirm rollback
Confluence wiki output
h2. Deploy runbook
{warning}
Confirm the release owner is online before starting.
{warning}
h3. Pre-checks
* Confirm staging passed
* Confirm the feature flag is enabled
* Confirm support is aware
h3. Deploy
{code:language=bash}
npm run build
npm run deploy
{code}
h3. Rollback
# Open the deploy dashboard
# Select the previous version
# Confirm rollbackCommon mistakes
- Do not paste raw fenced code blocks into a Confluence wiki field that expects macro syntax.
- Do not hide rollback steps inside a paragraph.
- Do not leave high-risk warnings as plain text when a Confluence warning macro would make them easier to scan.
FAQ
- What sections should a Confluence runbook include?
- Use purpose, pre-checks, procedure, rollback, verification, owners, and links. For short runbooks, pre-checks, procedure, rollback, and verification are enough.
- How do Markdown code blocks become Confluence code macros?
- A fenced block such as ```bash becomes a Confluence {code:language=bash} macro so commands keep formatting and syntax highlighting.
- Should warnings become Confluence macros?
- Yes. A line such as > Warning: Confirm backups first can become a {warning} macro, which makes operational risk easier to notice.
Related Confluence guides
Confluence Technical Spec Template
Format a Markdown technical spec for Confluence with problem, decision, architecture, tradeoffs, and open questions.
Markdown Incident Review to Confluence
Convert a Markdown incident review into a Confluence page with timeline, impact, root cause, and follow-up actions.
Markdown Meeting Notes to Confluence
Turn Markdown meeting notes into a Confluence page with decisions, action items, blockers, and links.