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

• Dedicated content elements for colors, fonts, icons, images and technical headlines
• Automatic table of contents for technical headlines
• Rich backend previews for all styleguide content elements
• Custom page type for styleguide pages with restricted content element availability
• Backend layout for styleguide pages
• Collection of TYPO3 ViewHelpers for reuse in templates

🔥 Installation

Requirements

• TYPO3 12, 13 or 14
• PHP 8.2+

Composer

composer require move-elevator/typo3-styleguide

Setup

Include static TypoScript template via the backend or import it:

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

📙 Documentation

• Content Elements
• ViewHelpers
• Backend Layout
• Page Type

🧑‍💻 Contributing

Please have a look at CONTRIBUTING.md.

⭐ License

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