How to render documentation¶
This page explains how to render a manual locally on your machine with Docker in order to test the rendering.
Run these commands in a terminal in the parent directory of the directory
Documentation. You should use a bash compatible shell, if possible.
Install Docker: https://docs.docker.com/install/
The docker image is not listed on Docker Hub (hub.docker.com) anymore, therefore some preparations need to be done once:
# pull 'latest' version from GitHub container repository docker pull ghcr.io/t3docs/render-documentation # The "real" tag is independent of the container repository, # so let's just create that extra "real" and "generic" tag docker tag ghcr.io/t3docs/render-documentation t3docs/render-documentation # verify it worked docker run --rm t3docs/render-documentation --version
Make dockrun_t3rd available in current terminal
source <(docker run --rm ghcr.io/t3docs/render-documentation show-shell-commands)
This will run the Docker container, in order to make the command
dockrun_t3rdavailable in your current terminal. You must do this again for every new terminal you open.
If this command does not work on your platform, look at Problems with source < (docker run ... for alternatives.
This will automatically find the documentation in the
Documentationsubfolder. It will create a directory
Documentation-GENERATED-tempand write the results there.
Open generated documentation
Look at the output of the previous command to see where the generated documentation is located or use one of these commands to directly open the start page in a browser: