README

TYPO3 CMS Content Blocks

This is the standalone repository for the TYPO3 Content Blocks project. Content Blocks provides a new API to create custom Content Types like Content Elements, Page Types or generic Record Types. Use it now in your TYPO3 v12/v13 project and eventually this will become a Core feature in TYPO3 v14 LTS.

Roadmap 2024

Installation

Require this package via composer:

composer req friendsoftypo3/content-blocks

Or install it via the Extension Manager in the TYPO3 backend. The extension key is content_blocks.

Usage

Refer to the Documentation on how to use the Content Blocks API.

JSON Schema

Enable validation and auto-completion with JSON schema

Developing

There is a ddev setup ready to use. Ensure ddev is installed on your machine. Then run:

ddev start
ddev composer install
touch .Build/public/FIRST_INSTALL
ddev launch

The default URL is https://content-blocks.ddev.site/. Continue with the TYPO3 installation process.

Testing

First install the composer dependencies:

composer install

Then run unit or functional tests by executing:

Build/Scripts/runTests.sh -s unit
Build/Scripts/runTests.sh -s functional

Hint

Be sure to exclude the .Build/public/typo3temp directory from indexing in your IDE (e.g. PhpStorm) before starting the tests.

Rendering the documentation

When you update the documentation you can try out rendering it locally (Docker required):

make docs

You can test if the syntax and references are ok with

make test-docs

Feedback

You can reach us on the TYPO3 Slack channel #cig-structuredcontent. We appreciate any constructive feedback.