EXT:docs
Fügt einen Dokumentations-Button in die TYPO3 Backend-Toolbar ein. Per Klick öffnet sich die Projektdokumentation in einem Modal-Iframe — direkt im Backend.
Was macht die Extension?
Redakteure und Entwickler brauchen Dokumentation nah an ihrer Arbeit. EXT:docs fügt ein Hilfe-Icon in die TYPO3 Backend-Toolbar ein. Ein Klick öffnet die konfigurierte Projektdokumentation direkt als Modal — ohne Tab-Wechsel, ohne Kontextverlust.
Ideal für Agenturen, die ihren Kunden eine sauber aufbereitete Inhaltsdokumentation direkt im TYPO3 anbieten möchten.
Konfiguration
Die Dokumentations-URL wird im Extension Manager unter Admin Tools → Einstellungen → Extension-Konfiguration → docs hinterlegt:
| Einstellung | Standard | Beschreibung |
|---|---|---|
docUrl | /_assets/docs/Inhalt/Inhaltselemente.html | URL zur Dokumentations-HTML-Seite |
Dokumentation generieren
Die Extension arbeitet hervorragend mit daux.io zusammen:
daux generate --destination=public/_assets/docs/Mit automatisch generierter Komponentendokumentation aus TYPO3:
ddev typo3 fbase:component:documentation \
packages/f_theme/Resources/Private/Ui \
--format=markdown > docs/Inhalt/Komponenten.md
daux generate --destination=public/_assets/docs/Installation
Als lokales Composer-Paket im Projekt einbinden:
composer require georgringer/docs