mirror of
https://github.com/FriendsOfTYPO3/tea.git
synced 2024-09-19 23:16:12 +02:00
fc5b861bcd
See c2bb63bead for further details.
The README.md should mostly only cover the abstract and links.
The composer commands are the core value of this extension. List
all commands in the documentation and copy the descriptions from
the `composer.json`. This lets the global search at docs.typo3.org
find these commands.
Remove superfluous Linters page, which is integrated now in the
Running page.
Use sentence case in page titles in order to conform to the
TYPO3 documentation standards.
The ambiguous :ts: text role has been removed to
not confuse the writer with typescript and typoscript.
Add the common extension destinations to `composer.json`.
(Packagist displays them in a prominent place.)
546 B
546 B
Documentation rendering
In order to render the documentation, this extension provides a Composer script that you can run locally via
Commands; composer docs:generate
composer docs:generateYou do not need to start or build the containers for this as this happens automatically.
For further details read the TYPO3 Documentation Rendering Guide <h2document:RenderingDocs/Quickstart>.