jetbrains/writerside-builder repository overview

For detailed instructions, see Build with Docker⁠.

When running a container from this image, mount the project sources directory (and an optional separate output directory) into the container and run the helpbuilderinspect command, which launches the CLI builder. For example, if you want to build the default instance hi in the starter project, run the following command from the project root:

docker run --rm -v .:/opt/sources \
jetbrains/writerside-builder:242.21870 \
/bin/bash -c "
export DISPLAY=:99 &&
Xvfb :99 &
/opt/builder/bin/idea.sh helpbuilderinspect \
--source-dir /opt/sources \
--product Writerside/hi \
--runner other \
--output-dir /opt/sources/output
"

This command does the following:

1. Mounts the current directory (you should be running it from the project root) to the directory /opt/sources in the container. If you want to output the built artifacts to a different directory, add a separate mount using another -v option.

2. Runs the container from the writerside-builder image.

3. The container first prepares the environment by setting the DISPLAY variable to :99 and running Xvfb :99 in the background to emulate a physical display on a virtual machine.

4. Then it runs the /opt/builder/bin/idea.sh script with the helpbuilderinspect command and options that specify directories with the sources and output, and the instance to build.

5. When it is done, Docker removes the container. You should find the output in the output directory under the project root.

The helpbuilderinspect command has the following options:

• --source-dir -i

  Specify the directory with documentation sources.

• --product -p

  Specify the module and instance that you want to build, separated by a slash /.

• --runner -r

  Specify the environment or platform on which the builder will be executed. The supported values are case-insensitive and include:

  • teamcity: This is the default value that produces artifacts specific for TeamCity.

  • gitlab: Produce artifacts specific for GitLab.

  • github: Produce artifacts specific for GitHub.

  • other: Produce generic artifacts that may require some adjustments for your environment.

• --output-dir -o

  Specify the output directory where the generated documentation will be stored.