Rendering container

For local rendering you can use the following command in the directory that contains the Documentation folder:

        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.

The init command

Use the init command to start writing TYPO3 documentation.

        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

This command creates a guides.xml configuration file and some example pages in folder Documentation.