---
title: "Introduction"
manual: "Code Highlight"
version: "main"
permalink: "https://docs.typo3.org/permalink/brotkrueml/codehighlight:introduction@main"
source: "Introduction/Index.rst"
rendered: "2026-10-12T15:16:44+00:00"
---

# Introduction {#introduction}

## What does it do? {#what-it-does}

In technical articles it is sometimes necessary to embed code snippets into the
text of a page. To improve the readability of the snippets, the syntax
highlighting of code is appreciated - as in modern IDEs.

The extension provides a new content element to achieve this goal. You can
choose between several themes.

## Screenshots {#screenshots}

### PHP code snippet {#php-code-snippet}

Example output using the Coy theme for a PHP code snippet with line numbers and
line highlighting:

![PHP code snippet with line numbers and line highlighting](../Images/Introduction/example-php.png)

### Shell command {#shell-command}

Example output using the Coy theme for a shell command with prompt:

![Shell command with prompt](../Images/Introduction/example-shell.png)

### CSS inline colours {#css-inline-colours}

Example output using the Coy theme for a CSS snippet with activated
inline colours (the coloured square before the colour definition):

![CSS snippet with inline colours](../Images/Introduction/example-css-inline-colours.png)

### Treeview {#treeview}

Example for a treeview to highlight file system tree structures:

![Treeview](../Images/Introduction/example-treeview.png)

## Release management {#release-management}

This extension uses [semantic versioning](https://semver.org/) which
basically means for you, that

-   Bugfix updates (for example, 1.0.0 => 1.0.1) just includes small bug fixes or
    security relevant stuff without breaking changes.
-   Minor updates (for example, 1.0.0 => 1.1.0) includes new features and smaller
    tasks without breaking changes.
-   Major updates (for example, 1.0.0 => 2.0.0) breaking changes which can be
    refactorings, features or bug fixes.