move-elevator/typo3-styleguide

This extension provides several tools for a TYPO3 styleguide.

dev-main 2025-08-05 08:33 UTC

Requires

• php: ^8.1
• ext-dom: *
• ext-intl: *
• blueways/bw-static-template: ^3.0 || ^4.0
• typo3/cms-core: ^11.0 || ^12.0 || ^13.0
• typo3/cms-fluid: ^11.0 || ^12.0 || ^13.0
• typo3fluid/fluid: ^2.15 || ^4.0

Requires (Dev)

• armin/editorconfig-cli: ^2.0
• eliashaeussler/php-cs-fixer-config: 2.3.0
• eliashaeussler/version-bumper: ^2.4 || ^3.0
• ergebnis/composer-normalize: ^2.44
• helhum/typo3-console: ^7.0 || ^8.1
• helmich/typo3-typoscript-lint: ^3.2
• move-elevator/composer-translation-validator: ^1.1
• phpstan/phpstan-deprecation-rules: ^1.0 || ^2.0
• phpstan/phpstan-strict-rules: ^1.0 || ^2.0
• saschaegerer/phpstan-typo3: ^1.10 || ^2.0
• spaze/phpstan-disallowed-calls: ^4.0
• ssch/typo3-rector: ^2.10 || ^3.0
• tomasvotruba/type-coverage: ^1.0 || ^2.0
• typo3/cms-base-distribution: ^12.0 || ^13.4
• typo3/cms-lowlevel: ^12.0 || ^13.4
• typo3/coding-standards: ^0.7 || ^0.8

GPL-2.0-or-later

• Konrad Michalik

README

TYPO3 extension typo3_styleguide

This extension provides several tools for a simple TYPO3 based styleguide.

Note

This extension is more of a best practice for implementing and maintaining an editorial style guide in TYPO3 with small reusable helpers.

✨ Features

• Content element for technical headlines with automatic table of contents
• Static templates for rendering any templates or partials
• Predefined template patterns for images, icons, colors and fonts
• Collection of TYPO3 ViewHelpers for reuse in templates
• Custom page type for styleguide pages
• Backend layout for styleguide pages

🔥 Installation

Requirements

• TYPO3 >= 11.5
• PHP 8.1+

Composer

composer require move-elevator/typo3-styleguide

TER

ToDo

Setup

Include static TypoScript template via the backend or import it:

@import 'EXT:typo3_styleguide/Configuration/TypoScript/setup.typoscript'

📙 Documentation

• Content Element
• Static Templates
• Patterns
• ViewHelpers
• BackendLayout
• PageType

🧑‍💻 Contributing

Please have a look at CONTRIBUTING.md.

💎 Credits

Style by Adrien Coquet from Noun Project (CC BY 3.0).

⭐ License

This project is licensed under GNU General Public License 2.0 (or later).