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).