ehaerer/rte-ckeditor-codesnippet

Integrates the CKEditor codesnippet plugin

1.0.1 2022-05-01 15:28 UTC

Requires

• php: >=7.2.0
• typo3/cms-core: ^9.5 || ^10.4 || ^11.5
• typo3/cms-rte-ckeditor: ^9.5 || ^10.4 || ^11.5

Suggests

• danielgoerz/fs-code-snippet: ^3.2

Replaces

• typo3-ter/rte-ckeditor-codesnippet: 1.0.1

GPL-2.0-or-later

• Ephraim Härer

• plugin
• CKEditor
• TYPO3 CMS
• codesnippet
• Site Package

README

This extension ships a simple plugin for the CkEditor to allow editors to insert coding tags inside text elements. The plugin itself has been taken from the CKEditor Inserting Code Snippet documentation without any changes.

At the moment it integrates the plugin version 4.18.0.

It suggests the extension fs_code_snippet to render the codesnippets in the frontend of your website.

Short overview:

Installation

Use composer require ehaerer/rte-ckeditor-codesnippet or download the extension from TER.

The extension requires the extension fs_code_snippet from TER or via Composer it will be required and installed automatically. fs_code_snippet is used to render the output in the frontend.

Usage

All it takes to enable the plugin are the following changes in your e.g. RTE.yaml with including the needed TsConfig and optional including the TypoScript configuration of fs_code_snippet:

1. Import the configuration from the extension in your RTE configuration:

imports:
    - { resource: "EXT:rte_ckeditor_codesnippet/Configuration/RTE/Plugin.yaml" }

1. Enable the plugin in your RTE configuration:

editor:
  config:
    extraPlugins:
      - codesnippet

1. Optional: include TypoScript constants and setup from fs_code_snippet in the configuration of your site package to render the code block in your website (frontend):

# constants
@import 'EXT:fs_code_snippet/Configuration/TypoScript/constants.txt'

# setup
@import 'EXT:fs_code_snippet/Configuration/TypoScript/setup.txt'

1. Check the results in the backend editor and in the frontend of your website.