• Products
  • Documentation
  • Resources

Insert the code block macro

This macro was intentionally excluded from the new editor and replaced with the Code Snippet element. Learn more

The Code Block macro allows you to display source code in your page with syntax highlighting, like the one below:

See a preview of the code block macro

Use the Code Block macro

To add the Code Block macro:

  1. When editing , select from the toolbar

  2. Find the item to be inserted and select it

  3. Select Insert

You can also type / on the page to bring up the same list you'd see by selecting from the toolbar.

To edit the Code Block macro:

  1. Select the macro placeholder. The floating toolbar appears.

  2. Select Edit. The right panel opens.

  3. Modify the parameters. Your changes are saved as you go.

  4. Resume editing the page, and the panel closes.

You type the code block directly into the macro placeholder in the editor. Note that any white space contained in the placeholder is not manipulated in any way by the Code Block macro. This is to provide the writer with flexibility over code indentation.

Parameters

Parameters are options that you can set to control the content or format of the macro output. 

If the parameter name used in Confluence Cloud storage format or wikimarkup is different than the label used when inserting macros using the browser or the slash command, it will be listed below in brackets (example).

Parameter

Default

Description

Syntax highlighting
(language

java

Specifies the language (or environment) for syntax highlighting. The default language is Java but you can choose from one of the following languages/environments:

  • ActionScript

  • AppleScript

  • Bash

  • C#

  • C++

  • CSS

  • ColdFusion

  • Delphi

  • Diff

  • Erlang

  • Groovy

  • HTML and XML

  • Java

  • Java FX

  • JavaScript

  • Plain Text

  • PowerShell

  • Python

  • Ruby

  • SQL

  • Sass

  • Scala

  • Visual Basic

Title

none

Adds a title to the code block. If specified, the title will be displayed in a header row at the top of the code block.

Collapsible
(collapse

false

If selected, the code macro's content will be collapsed upon visiting or refreshing the Confluence page. Clicking the expand source link allows you to view this content. If false, the code macro's content is always displayed in full.

Show line numbers
(linenumbers)

false

If selected, line numbers will be shown to the left of the lines of code.

First line number
(firstline

1

When Show line numbers is selected, this value defines the number of the first line of code.

Theme

Default

Specifies the color scheme used for displaying your code block. Many of these themes are based on the default color schemes of popular integrated development environments (IDEs). The default theme is Confluence (also known as Default), which is typically black and colored text on a blank background. However, you can also choose from one of the following other popular themes:

  • DJango

  • Emacs

  • FadeToGrey

  • Midnight

  • RDark

  • Eclipse

  • Confluence

Wiki markup example

Wiki markup is only supported in the legacy editor.

Wiki markup is useful when you need to add a macro outside the editor, for example as custom content in the sidebar, header or footer of a space.

Macro name: code

Macro body: Accepts plain text.

1 2 3 4 5 6 {code:title=This is my title|theme=FadeToGrey|linenumbers=true|language=html/xml|firstline=0001|collapse=true} This is my code {code}

 

Additional Help