georgringer/docs

Backend documentation toolbar for WSK

Maintainers

Package info

github.com/georgringer/docs

Type:typo3-cms-extension

pkg:composer/georgringer/docs

Fund package maintenance!

georgringer

paypal.me/GeorgRinger/10

www.amazon.de/hz/wishlist/ls/8F573K08TSDG

Patreon

Statistics

Installs: 13

Dependents: 0

Suggesters: 0

Stars: 0

Open Issues: 0

Security

Advisories: 0

Aikido package health analysis

1.0.0 2026-04-13 08:11 UTC

Requires

GPL-2.0-or-later ffcf78d4f985448be06a3a6a1ffb45693199bb3e

This package is auto-updated.

Last update: 2026-04-13 08:12:45 UTC

README

TYPO3 backend extension that adds a documentation toolbar button. Clicking the button opens the project documentation in an iframe modal.

Features

  • Toolbar icon in the TYPO3 backend (help icon)
  • Opens a configurable documentation URL in a modal iframe
  • Fully translatable (EN/DE included)

Configuration

The documentation URL can be changed in the TYPO3 Extension Manager or Install Tool under Admin Tools → Settings → Extension Configuration → docs.

Setting Default Description
docUrl /_assets/docs/Inhalt/Inhaltselemente.html URL to the documentation HTML page

Generating the documentation

The documentation is built with daux.io from the docs/ directory:

# Static HTML generieren
daux generate --destination=public/_assets/docs/

To also include auto-generated component documentation from 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

The package is included as a local path repository via Composer:

composer require georgringer/docs