Skip to end of banner Go to start of banner

Better Code Block Documenation

Skip to end of metadata

Created by Matthew Grover, last modified on Jul 23, 2024

Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Better Code Block for Confluence is a Macro which contains all the features you could ever want from a code macro:

Secure - All data and code is stored and processed on Atlassian servers so extra security risk
Syntax highlighting for over 300 languages, including Gherkin
One button to copy the code
Multiple themes to choose from to suit the page style or use different themes for different languages
Line highlighting to shows which bits of code are important
Macro can be configured to start collapsed so it does not make the document too long
Customizable title for each macro so you can let people know what the code is
Focus lines so you by default the Macro only shows a subset of lines but can be expanded
Configurable line numbers so you can choose to show them only when they are useful

Basic Usage

Edit a page or Create a new page and type /better click on the Better Code Block option when it appears.

download (50).png

Click on the Edit pencil icon which appears below the newly inserted macro

Options will appear to the right hand side, write or copy and paste your code into the “Code to display” field and select the language from the Language dropdown. See below for instructions on all options.

download (54).png

Syntax Highlighting

Over 300 languages are supported, see the Supported Languages section for a full list.

To choose a language, simply click on the Language dropdown and either scroll to find your language or start typing and the list will be filtered so you can then easily select your language.

download (56).png

Themes

Better Code Block comes with eight themes, simply select one from the dropdown, some examples are shown below

download (57).png

Default

We don't have a way to export this macro.

Tomorrow Night

We don't have a way to export this macro.

Line Highlighting

You can configure the Code Block to highlight certain lines to make them stand out. These are specified as groups separated by commas, each group can either by a single line number or a start and end range of lines separated by a hyphen -.

e.g. the below code has 1,3-4 set in the Lines to Highlight field

We don't have a way to export this macro.

Auto Collapse

Long pieces of code can make clutter up a page and make it difficult to scroll. If you set Start collapsed with just title showing to Yes then only the title will be shown by default as below but you will still be able to easily open up the code when it is relevant to you by pressing the > button.

We don't have a way to export this macro.

download (60).png

Custom Title

Your code blocks can have custom titles displayed at the top which can be used to give some context to the code and are very useful when the macro uses Auto Collapse.

We don't have a way to export this macro.

download (58).png

Focus Lines

Focus Lines allow you to choose a subset of lines to be visible by default, but also allow viewers to expand to the full code snippet for more context using the + button. This is either a single line number or a range with start and end separated by a hyphen, e.g. 4 or 16-20.

We don't have a way to export this macro.

download (59).png

Configurable Line Numbers

By default, line numbers are shown by you can choose to have them turned off if they are not relevant.

We don't have a way to export this macro.

download (61).png

Supported Languages

No labels