Installation

This project is not a TYPO3 extension, but a standalone application used to render documentation. If you want to learn more about how to write documentation, please check the Contributing Guide - How to Document.

Multiple methods are provided to install the project on your local machine. You can choose whatever is easiest for you:

Using Docker natively, with a provided official container
Using Docker natively, with a locally-generated container
Using DDEV (utilizing Docker)
Using PHP

Note

The Docker container is the recommended way to use this project for end-users. It will automatically set up all dependencies and will not interfere with your local PHP installation or project. The container can be used in any project (and in any GitHub action) without further dependencies.

Tip

Did you know: Instead of the docker client you can also use the lightweight drop-in replacement Podman to run the mentioned containers by replacing all docker commands in the following steps with podman.

Docker

The Docker image is available on GitHub packages. You can pull the image with the following command.

docker pull ghcr.io/typo3-documentation/render-guides:latest

For all available tags, please check the GitHub packages page. Once you have pulled the image, you can run the image to render your project's documentation.

Note

The Docker container internally contains a tagged release version of this repository, and use that version as well to reference asset URIs of the theme on our CDN.

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

Unlike other Docker images, this image will detect the owner-user of the mounted project. This means that the files created by the Docker image will have the same owner as the files in your project. No more permission issues should occur, when files are getting generated inside the image.

Note

Note that the parameter -v $(pwd):/project always uses project as the directory name. You do not need to replace that directory name with anything else, because the container rendering depends on this.

If this fails, you can resort to specifying the user:

docker run --rm --user=$(id -u):$(id -g) -v $(pwd):/project ghcr.io/typo3-documentation/render-guides:latest --progress --config ./Documentation

The provided image allows you to also perform a few other actions:

# Convert Settings.cfg to guides.xml:
docker run --rm -v $(pwd):/project ghcr.io/typo3-documentation/render-guides:latest migrate ./Documentation

# Check guides.xml files for XML conformity
docker run --rm -v $(pwd):/project ghcr.io/typo3-documentation/render-guides:latest lint-guides-xml

# Adapt guides.xml programmatically (work in progress)
docker run --rm -v $(pwd):/project ghcr.io/typo3-documentation/render-guides:latest configure \
  --project-version="2.2" \
  --project-title="My project title" \
  --project-release="2023" \
  --project-copyright="2000-2023" ./Documentation

In case of errors you can increase verbose output by prefixing any command with the argument verbose:

# Execute verbose commands with inline setting
docker run --rm -v $(pwd):/project ghcr.io/typo3-documentation/render-guides:latest verbose (render|migrate|lint-guides-xml|configure) [arguments/options]

# Execute verbose commands with inline setting, useful for i.e. external actions
SHELL_VERBOSITY=3 docker run --rm -v $(pwd):/project ghcr.io/typo3-documentation/render-guides:latest (render|migrate|lint-guides-xml|configure) [arguments/options]

Another way to utilize Docker is to create your own image/container. This is aimed at people who want to contribute to the underlying Documentation tool. Please see Building for those steps.

DDEV

DDEV is a utility layer on top of Docker. It allows to easily build and maintain local development instances with specific environments.

This project also ships a .ddev/ configuration directory, that allows you to start a specific container in which you can render Documentation, and have an environment where you can contribute to this repository without any other requirement than Docker and DDEV.

To render the documentation you can run

ddev start
ddev composer install
ddev composer make docs

PHP

If your host environment already has a PHP binary and is able to run Composer, as well as interpret Makefile syntax (i.e. through a build-essential package), you can create documentation natively, without needing docker.

You can run these commands locally:

composer install
make docs

The provided Symfony Commands can be executed via:

./packages/typo3-guides-cli/bin/typo3-guides (migrate|lint-guides-xml|configure)