Quick Start Guide

Get up and running with your first diagram or equation in under 5 minutes.

Who This Guide Is For

• Admins: install and validate the app - see Installation & Setup
• All page editors: insert macros, write content, edit later

Quick Checklist

Inserting Your First Diagram

1. Edit a Confluence page and type /Diagrams
2. Click UML Diagrams in the macro list

1. The split-view editor opens - the Source panel is on the left

2. Paste a sample diagram or type your own Mermaid code, for example:

   flowchart TD
       A[Start] --> B{Decision}
       B -->|Yes| C[Do it]
       B -->|No| D[Skip it]
       C --> E[End]
       D --> E
   

3. The Preview panel on the right renders the diagram live

1. Click Save - the diagram appears on the page

Inserting Your First Equation

1. Edit a page and type /LaTeX Block
2. Click LaTeX Block Equations

1. In the Source panel, type raw LaTeX - for example: \frac{a}{b}
2. Preview renders the equation on the right
3. Click Save - the display equation appears on the page

Inserting Inline Math

1. Edit a page and type /LaTeX Inline
2. Click LaTeX Inline Equations
3. In the Source panel, write normal text and LaTeX equations, for example:

The area of a circle is A = \pi r^2 where r is the radius.

1. Click Save - the paragraph renders with embedded math

Editing Existing Content

Edit a Diagram or LaTeX Block

1. View the published page
2. Hover over the rendered macro
3. Click the Edit (pencil) icon in the hover toolbar
4. The modal editor reopens with your saved source
5. Update the content and click Save/Publish

Edit Inline Equations

1. Hover over the inline content block
2. Click the Edit icon
3. Update the paragraph and formulas
4. Click Save changes

Pro Tip: Safe Editing Workflow

When making large changes:

1. Copy your current source into a temporary note before editing
2. Make edits incrementally
3. Save and verify rendering at each step
4. If something breaks, paste back from your note

Common Paths

• Admin setup → Installation & Setup
• Diagram reference → Diagrams Macro
• LaTeX reference → LaTeX Block Equations
• Inline math → LaTeX Inline Equations
• Code examples → Examples Library