Documentation

Owned by weweave UG
Last updated: Jan 03, 2025
4 min read

Installation

As any app for Jira Cloud, you can install the app via the Jira admin menu.

  1. Log into your Jira instance as an admin.

  2. Click on “Apps > Manage apps” in the header menu.

  3. Click on “Find new apps” on the right navigation.

  4. Search for “Mermaid Charts & Diagrams for Jira” and select it.

  5. Click on “Try it free” to install the app.

Usage

Prism Syntax Highlighter for Jira provides an app that allows you to add highlighted source code to any Jira issue. To use add the source code to an issue, select the app as shown in the screenshot below.

image-20241218-114540.png

This should add a new section to the issue looking as follows:

image-20241218-114619.png

To define the diagram code, click the “Edit” button and enter the source code in the editor and click “Save”:

After saving the source code, it is shown as follows:

JQL support

The source code can by queried via JQL by using the property “prismCode”. To search issues with a source code containing a keywords use the ~ operator as follows:

prismCode ~ YourKeywordHere

The property “prismCount” can be used to query for issues that contain or do not contain any source code. To find issues with a source code use

mermaidCount IS NOT EMPTY

and to find issues that do not have any source code use

mermaidCount IS EMPTY

Supported languages

Prism Syntax Highlighter for Jira supports the following languages:

  • ABAP

  • Augmented Backus–Naur form

  • ActionScript

  • Ada

  • Agda

  • AL

  • ANTLR4

  • Apache Configuration

  • Apex

  • APL

  • AppleScript

  • AQL

  • Arduino

  • ARFF

  • ARM Assembly

  • Arturo

  • AsciiDoc

  • 6502 Assembly

  • ASP.NET (C#)

  • Atom

  • AutoHotkey

  • AutoIt

  • AviSynth

  • Avro IDL

  • AWK + GAWK

  • Bash

  • BASIC

  • Batch

  • BBcode

  • BBj

  • Bicep

  • Birb

  • Bison

  • Backus–Naur form

  • BQN

  • Brainfuck

  • BrightScript

  • Bro

  • BSL (1C:Enterprise) + OneScript

  • C

  • C-like

  • Concurnas

  • C#

  • C++

  • CFScript

  • ChaiScript

  • CIL

  • Cilk/C

  • Cilk/C++

  • CoffeeScript

  • CMake

  • COBOL

  • Clojure

  • Crystal

  • Content-Security-Policy

  • Cooklang

  • Coq

  • CSS

  • CSS Extras

  • CSV

  • CUE

  • Cypher

  • D

  • Dart

  • DataWeave

  • DAX

  • Dhall

  • Diff

  • Django/Jinja2

  • DNS zone file

  • Docker

  • DOT (Graphviz)

  • Extended Backus–Naur form

  • EditorConfig

  • Eiffel

  • EJS

  • Elixir

  • Elm

  • Embedded Lua templating

  • ERB

  • Erlang

  • Excel Formula

  • F#

  • Factor

  • False

  • Firestore security rules

  • Flow

  • Fortran

  • FreeMarker Template Language

  • G-code

  • GDScript

  • GEDCOM

  • gettext

  • Gherkin

  • Git

  • GLSL

  • GameMaker Language

  • GAP (CAS)

  • GN

  • GNU Linker Script 

  • Go

  • Go module

  • Gradle

  • GraphQL

  • Groovy

  • Haml

  • Handlebars

  • Haskell

  • Haxe

  • HCL

  • HLSL

  • Hoon

  • HTML

  • HTTP

  • HTTP Public-Key-Pins

  • HTTP Strict-Transport-Security

  • IchigoJam

  • Icon

  • ICU Message Format

  • Idris

  • Ignore Files

  • Structured Text (IEC 61131-3)

  • Inform 7

  • Ini

  • Io

  • J

  • Java

  • JavaDoc

  • JavaDoc-like

  • JavaScript

  • Java stack trace

  • Jexl

  • Jolie

  • JQ

  • JSDoc

  • JS Extras

  • JSON

  • JSON5

  • JSONP

  • JS stack trace

  • JS Templates

  • Julia

  • Keyman

  • Kotlin

  • KuMir

  • Kusto

  • LaTeX

  • Latte

  • Less

  • LilyPond

  • LiquidLisp

  • LiveScript

  • LLVM IR

  • Log file

  • LOLCODE

  • Lua

  • Magma (CAS)

  • Makefile

  • Markdown

  • Markup

  • Markup templating

  • Mata

  • MathML

  • MATLAB

  • MAXScript

  • MEL

  • Mermaid

  • METAFONT

  • Mizar

  • MongoDB

  • Monkey

  • MoonScript

  • N1QL

  • N4JS

  • Nand To Tetris HDL

  • Naninovel Script

  • NASM

  • NEON

  • Nevod

  • nginx

  • Nim

  • Nix

  • NSIS

  • Objective-C

  • OCaml

  • Odin

  • OpenCL

  • OpenQasm

  • Oz

  • PARI/GP

  • Parser

  • Pascal

  • Pascaligo

  • PATROL Scripting Language

  • PC-Axis

  • PeopleCode

  • Perl

  • PHP

  • PHPDoc

  • Plant UML

  • PHP Extras

  • PL/SQL

  • PowerQuery

  • PowerShell

  • Processing

  • Prolog

  • PromQL

  • .properties

  • Protocol Buffers

  • Pug

  • Puppet

  • Pure

  • PureBasic

  • PureScript

  • Python

  • Q (kdb+ database)

  • Q#

  • QML

  • Qore

  • R

  • Racket

  • Razor C#

  • React JSX

  • React TSX

  • Reason

  • Regex

  • Rego

  • Ren'py

  • ReScript

  • reST (reStructuredText)

  • Rip

  • Roboconf

  • Robot Framework

  • RSS

  • Ruby

  • Rust

  • SAS

  • Sass (Sass)

  • Sass (Scss)

  • Scala

  • Scheme

  • Shell session

  • Smali

  • Smalltalk

  • Smarty

  • SML + SML/NJ

  • Solidity (Ethereum)

  • Solution file

  • Soy (Closure Template)

  • SPARQL

  • Splunk SPL

  • SQF: Status Quo Function (Arma 3)

  • SQL

  • Squirrel

  • Stan

  • Stata Ado

  • Stylus

  • SuperCollider

  • SVG

  • Swift

  • TAP

  • Tcl

  • Textile

  • TOML

  • Template Toolkit 2

  • Turtle

  • Twig

  • TypeScript

  • TypoScript + TSConfig

  • Systemd configuration file

  • T4 Text Templates (C#)

  • T4 Text Templates (VB)

  • T4 templating

  • UnrealScript

  • UO Razor Script

  • URI + URL

  • V

  • Vala

  • VB.Net

  • Velocity

  • Verilog

  • VHDL

  • vim

  • Visual Basic

  • Visual FoxPro

  • WarpScript

  • WebAssembly

  • Web IDL

  • WGSL

  • Wiki markup

  • Wolfram language + Mathematica + Mathematica Notebook

  • Wren

  • Xeora

  • XML

  • XML doc (.net)

  • Xojo (REALbasic)

  • XQuery

  • YAML

  • YANG

  • Zig