User Guide

Start Here - Guide by Role

LaTeX Formulas & Diagrams adds three macros to the Confluence editor: UML Diagrams (Mermaid), LaTeX Block Equations, and LaTeX Inline Equations. All three open the same split-view editor. Use this guide to find the right starting point for your role.

Technical Writer / Documentation Lead

You write technical documentation and need diagrams and formatted equations embedded in pages.

Start with:

  1. Quick Start Guide - insert your first diagram in under 3 minutes
  2. Diagrams Macro - full Mermaid diagram reference (flowcharts, sequence diagrams, ERDs, Gantt charts)
  3. How to: Document a System Architecture - end-to-end workflow
  4. Examples Library - copy-paste ready examples for every diagram type

Developer / Software Engineer

You need architecture diagrams, sequence diagrams, and ERDs directly in Confluence.

Start with:

  1. Diagrams Macro - Mermaid syntax reference
  2. Diagram Types Reference - all supported diagram types with examples
  3. How to: Document a System Architecture - flowchart + sequence + ERD in one page

Data Scientist / Researcher / Analyst

You need mathematical formulas and equations in documentation or reports.

Start with:

  1. LaTeX Block Equations - standalone centred equations
  2. LaTeX Inline Equations - math embedded inside paragraph text
  3. Formula Library Reference - ready-to-use LaTeX for common formulas
  4. How to: Create Technical Docs with Math - full workflow

Documentation Manager / Confluence Admin

You install apps and want to understand what this adds to your instance.

Start with:

  1. Installation & Setup - install from Atlassian Marketplace
  2. Permissions & Access - what the app accesses and how content is stored