Basic principles

TYPO3 documentation is written in reStructuredText (reST) and rendered to HTML using a shared toolchain. Most documentation is hosted on https://docs.typo3.org and follows a common structure and style.

Table of content

Types of documentation

Documentation may include:

Official manuals (e.g. TYPO3 Explained)
System extension manuals
Core changelog entries
Third-party extension manuals

Rendering

Rendering converts .rst source files into styled HTML output. You can preview docs locally using the official Docker container:

        Execute in extension root, the directory that contains your extensions composer.json
    

docker run --rm --pull always -v $(pwd):/project -it ghcr.io/typo3-documentation/render-guides:latest --config=Documentation

Open the file saved to Documentation-GENERATED-temp/Index.html in a browser of your choice.

Contributing to official documentation

Everyone is welcome to contribute to TYPO3’s official documentation.

Most manuals are hosted on GitHub. You can suggest changes directly by clicking Edit on GitHub on any page.

For larger contributions or local editing, see the full guide at Contribute to the TYPO3 documentation.

Documenting your own extension

To document your TYPO3 extension, create a Documentation folder in your extension and add .rst files following the standard structure.

We provide a Docker command to get started with documenting an extension:

        Execute in extension root, the directory that contains your extensions composer.json
    

docker run --rm --pull always -v $(pwd):/project -it ghcr.io/typo3-documentation/render-guides:latest init

Help and support

Need help with TYPO3 documentation? Join the TYPO3 Slack workspace and post your question in the #typo3-documentation channel.

To register, visit: https://my.typo3.org/index.php?id=35

For general TYPO3 support, see https://typo3.org/help/.

You can also contact the Documentation Team by email: [email protected]