Render documentation with the TYPO3 theme

Rendering the Documentation folder locally with Docker

You can render the documentation of an official TYPO3 manual or a third-party manual with the following steps:

  1. Clone the repository containing the documentation.
  2. Navigate to the extension's root folder, the directory which contains the composer.json.
  3. Check if there is documentation to be rendered:

    A folder called Documentation containing at least the files Index.rst and guides.xml.

  4. Choose your preferred method of rendering (See below):

Make sure that Docker is installed on your system.

mkdir -p Documentation-GENERATED-temp
docker run --rm --pull always -v $(pwd):/project -it --config=Documentation
xdg-open "Documentation-GENERATED-temp/Index.html"
mkdir -p Documentation-GENERATED-temp
docker run --rm --pull always -v $(pwd):/project -it --config=Documentation
open "Documentation-GENERATED-temp/Index.html"
New-Item -ItemType Directory -Force -Path ".\Documentation-GENERATED-temp"
docker run --rm --pull always -v ${PWD}:/project -it --config=Documentation
start "Documentation-GENERATED-temp/Index.html"

Publishing extension documentation to

For your documentation to be published to, your TYPO3 extension has to have a valid composer.json and either a folder called Documentation with a Documentation/Index.rst and a Documentation/guides.xml or a README.rst / in the extension's root directory.

The extension has to be publicly available on GitHub or GitLab. You have to establish a Webhook and the Documentation Team has to approve your first rendering.

Introduce automatic testing for extension documentation

It is recommended to make sure your documentation always renders without warning. On GitHub or GitLab you can introduce actions that test your documentation automatically:

name: test documentation

on: [ push, pull_request ]

    name: documentation
    runs-on: ubuntu-latest
      - name: Checkout
        uses: actions/checkout@v4

      - name: Test if the documentation will render without warnings
        run: |
          mkdir -p Documentation-GENERATED-temp \
          && docker run --rm --pull always -v $(pwd):/project \
    --config=Documentation --no-progress --fail-on-log
  - test

  stage: test
    - mkdir -p Documentation-GENERATED-temp
    - docker run --rm --pull always -v $(pwd):/project --config=Documentation --no-progress --fail-on-log
    - docker