Installation

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

1. Log into your Confluence 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 “Prism Syntax Highlighter for Confluence” and select it.

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

Usage

Macros “Prism syntax highlighter” & "Prism syntax highlighter (Remote)"

Prism Syntax Highlighter for Confluence provides two macros to highlight source code on any Confluence page. One macro can be used to define the source code in the macro’s body in Confluence and the other macro includes the source code from a remote location (such as GitHub). To make use of the first option click the “Insert” / “+” Button in the edit mode and select the “Prism Syntax Highlighter” macro and add the source code as macro body. To include source code from a remote location add the “Prism Syntax Highlighter (Remote)” macro and set the macro option “URL” to the remote location.

Both macros support the following options:

• Language: Select the language of the source code to highlight.

• Height: Optionally define the macro’s height.

• Limit height: Check to limit the defined macro’s height to the actual source code height.

• Line numbers: Check to add line numbers.

• First line number: If “Line numbers” option is checked, this options defines the line number to start from (leave empty to start from 1).

• Lines(s) to highlight: Add the lines that should be highlighted in format “1-2,5,9-20”.

• Download filename: Add a filename to allow downloading the source code.

• Dialog title: Add a dialog title to allow opening the source code in a fullscreen dialog.

• Show previews: Check to show previews (works for CSS, Less, Markup attributes, Sass, Scss and Stylus source code)

• Show invisibles: Check to show hidden characters such as tabs and line breaks.

• Clickable links: Check to convert URLs and emails in code to clickable links.

The “Prism Syntax Highlighter (Remote)” macro specific options are

• URL: URL to load the remote source code from

• Server side: Check to load remote content from the server side to overcome CORS issues

Macros "Prism command line highlighter (Bash)", "Prism command line highlighter (PowerShell)" & “Prism command line highlighter (SQL)“

Prism Syntax Highlighter for Confluence provides three macros to render a Bash, a PowerShell or a SQL command line on any Confluence page. The (input) commands and the output lines are defined in the macro’s body. To make use of this option click the “Insert” / “+” Button in the edit mode and select the corresponding macro and add the command line content as macro body.

The macros support the following options:

• Only macro "Prism command line highlighter (Bash)"

  • User: User that should be rendered in the command line.

  • Host: User that should be rendered in the command line.

• Only macro "Prism command line highlighter (PowerShell)"

  • Directory: Current (working) directory that should be rendered in the command line.

• Only macro "Prism command line highlighter (SQL)"

  • Server: Server (suffixed) with “>” is shown as prompt

• Height: Optionally define the macro’s height.

• Limit height: Check to limit the defined macro’s height to the actual source code height.

• Dialog title: Add a dialog title to allow opening the source code in a fullscreen dialog.

An example content for the macro "Prism command line highlighter (Bash)" could look as follows:

An example content for the macro "Prism command line highlighter (SQL)" could look as follows:

Macro "Prism directory treeview"

Prism Syntax Highlighter for Confluence provides a macro to render a directory treeview. To make use of this option click the “Insert” / “+” Button in the edit mode and select the "Prism directory treeview" macro and add the treeview as macro body (see below for an example).

The macros support the following options:

• Height: Optionally define the macro’s height.

• Limit height: Check to limit the defined macro’s height to the actual source code height.

• Dialog title: Add a dialog title to allow opening the source code in a fullscreen dialog.

An example content for the macro "Prism directory treeview" could look as follows:

App configuration

As a Confluence administrator you can access the app’s global configuration page via the “Configure” button under “Apps > Manage apps”.

Open

The app offers the following (global) settings which are applied to all Prism Syntax Highlighter for Confluence macros (in all spaces):

• Data Protection Mode: If enabled, all data processing takes place only within the Atlassian cloud and within the user's browser. This is implemented by disabling those features where data processing on the app’s servers (managed by weweave) is required.

• Hide “Data Protection Mode” errors in Confluence Word or PDF exports: If enabled (only possible in combination with enabling “Data Protection Mode”), Confluence Word and PDF exports do not include macros (errors). Instead, macros are just “skipped” in exports.

• Custom CSS: Global (custom) CSS to apply additional stylings to the source code rendering (see below for examples).

Open

Custom CSS

To customize the rendering of the Prism macros, custom CSS code can be defined on a global (Confluence) level.

The following examples adds a red border to all line highlightings:

Supported languages

Prism Syntax Highlighter for Confluence supports the following languages: