Documentation Tabs & Mermaid for Jira

Organize Jira issues and project pages with interactive tabbed views and Mermaid diagrams. Add descriptions, drag and drop, and reuse tab layouts for efficient documentation and planning.

Getting Started

Access the Tabs Panel

  • In any Jira issue or project page, locate the "Tabs & Mermaid" section. This will appear as a new panel or tab, depending on your configuration.

    Tabs panel inside a Jira issueTabs panel inside a Jira issue

Create and Edit Tabs

  • Click "Add Tab" to create a new tab.

    Add a new tab
  • Click "Show Description" to display the description field.

    Show description field
  • Type a description and click Save.

    Save description
  • Create a diagram. Click on the "Create Content" or "Edit Content" button.

    Create or edit diagram content
  • Supported diagram types include:

    • Flowcharts
    • Sequence diagrams
    • Gantt charts
    • Class diagrams
    • ER diagrams
  • Example:

mindmap
  root((mindmap))
    Origins
      Long history
      ::icon(fa fa-book)
      Popularisation
        British popular psychology author Tony Buzan
    Research
      On effectiveness<br/>and features
      On Automatic creation
        Uses
            Creative techniques
            Strategic planning
            Argument mapping
    Tools
      Pen and paper
      Mermaid
Mermaid diagram inside a tab
  • Click "Preview" to see the rendered diagram.

    Preview button
  • To rename a tab title, click on the tab label, update the text, and save.

    Rename a tab - open editorRename a tab
  • To reorder tabs, click and hold on a tab, then drag it to a new position.

    Drag and drop a tab to reorder

Clone Tabs Between Issues or Projects

  • Click the "Clone" icon to copy the entire set of tabs to another issue or project.

  • Select the target location and confirm the operation.

    Clone tabs to another Jira issue

Enjoy a Clean, Structured Jira Experience

Tabs & Mermaid for Jira brings organization and clarity to your documentation workflow—right where your team collaborates.

Clean tab layout with Mermaid diagram