From a88cf90e0fd6690c9e561f6a8885ac6e82b8c477 Mon Sep 17 00:00:00 2001 From: davidvader Date: Fri, 17 Jan 2025 15:15:29 -0600 Subject: [PATCH] fix: docusaurus compatible formatting --- DOCS.md | 78 ++++++++++++++++++++++++++++----------------------------- 1 file changed, 39 insertions(+), 39 deletions(-) diff --git a/DOCS.md b/DOCS.md index 9e5efbe..2eae06d 100644 --- a/DOCS.md +++ b/DOCS.md @@ -182,45 +182,45 @@ The following parameters are used to configure the image: | Name | Description | Required | Default | Environment Variables | | ----------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -------- | ----------------- | ------------------------------------------------------------------- | -| `add_hosts` | set a custom host-to-IP mapping - format (host:ip) | `false` | N/A | `PARAMETER_ADD_HOSTS`
`DOCKER_ADD_HOSTS` | -| `build_args` | set variables to pass to the image at build-time | `false` | N/A | `PARAMETER_BUILD_ARGS`
`DOCKER_BUILD_ARGS` | -| `cache_from` | set of images to consider as cache sources | `false` | N/A | `PARAMETER_CACHE_FROM`
`DOCKER_CACHE_FROM` | -| `cgroup_parent` | set a parent cgroup for the container | `false` | N/A | `PARAMETER_CGROUP_PARENT`
`DOCKER_CGROUP_PARENT` | -| `compress` | enable compressing the build context using gzip | `false` | `false` | `PARAMETER_COMPRESS`
`DOCKER_COMPRESS` | -| `context` | set of files and/or directory to build the image from | `true` | `.` | `PARAMETER_CONTEXT`
`DOCKER_CONTEXT` | -| `cpu` | set the cpu parameter, see [cpu](#cpu) settings below | `false` | N/A | `PARAMETER_CPU`
`DOCKER_CPU` | -| `daemon` | set the daemon parameter, see [daemon](#daemon) settings below | `false` | N/A | `PARAMETER_DAEMON`
`DOCKER_DAEMON` | -| `disable_content_trust` | enable skipping verification of the image | `false` | `true` | `PARAMETER_DISABLE_CONTENT_TRUST`
`DOCKER_DISABLE_CONTENT_TRUST` | -| `dry_run` | enable building the image without publishing | `false` | `false` | `PARAMETER_DRY_RUN`
`DOCKER_DRY_RUN` | -| `file` | set the name of the Dockerfile | `false` | N/A | `PARAMETER_FILE`
`DOCKER_FILE` | -| `force_rm` | enable always removing the intermediate containers after a successful build | `false` | `false` | `PARAMETER_FORCE_RM`
`DOCKER_FORCE_RM` | -| `image_id_file` | set the file to write the image ID to | `false` | N/A | `PARAMETER_IMAGE_ID_FILE`
`DOCKER_IMAGE_ID_FILE` | -| `isolation` | set container isolation technology | `false` | N/A | `PARAMETER_ISOLATION`
`DOCKER_ISOLATION` | -| `labels` | set metadata for an image | `false` | N/A | `PARAMETER_LABELS`
`DOCKER_LABELS` | -| `log_level` | set the log level for the plugin | `true` | `info` | `PARAMETER_LOG_LEVEL`
`DOCKER_LOG_LEVEL` | -| `memory` | set memory limit | `false` | N/A | `PARAMETER_MEMORY`
`DOCKER_MEMORY` | -| `memory_swaps` | set the swap limit equal to memory plus swap: '-1' to enable unlimited swap | `false` | N/A | `PARAMETER_MEMORY_SWAPS`
`DOCKER_MEMORY_SWAPS` | -| `network` | set the networking mode for the RUN instructions during build | `false` | N/A | `PARAMETER_NETWORK`
`DOCKER_NETWORK` | -| `no_cache` | disable caching when building the image | `false` | `false` | `PARAMETER_NO_CACHE`
`DOCKER_NO_CACHE` | -| `output` | set the output destination - format (type=local,dest=path) | `false` | N/A | `PARAMETER_OUTPUTS`
`DOCKER_OUTPUTS` | -| `password` | set password for communication with the registry | `true` | N/A | `PARAMETER_PASSWORD`
`DOCKER_PASSWORD` | -| `platform` | set a platform if server is multi-platform capable | `false` | N/A | `PARAMETER_PLATFORM`
`DOCKER_PLATFORM` | -| `progress` | set type of progress output - options (auto\|plain\|tty) | `false` | N/A | `PARAMETER_PROGRESS`
`DOCKER_PROGRESS` | -| `pull` | enable always attempting to pull a newer version of the image | `false` | `false` | `PARAMETER_PULL`
`DOCKER_PULL` | -| `quiet` | enable suppressing the build output and print image ID on success | `false` | `false` | `PARAMETER_QUIET`
`DOCKER_QUIET` | -| `registry` | set Docker registry address to communicate with | `true` | `index.docker.io` | `PARAMETER_REGISTRY`
`DOCKER_REGISTRY` | -| `remove` | enable removing the intermediate containers after a successful build | `false` | `true` | `PARAMETER_REMOVE`
`DOCKER_REMOVE` | -| `repo` | set Docker repository for the image | `false` | N/A | `PARAMETER_REPO`
`DOCKER_REPO` | -| `secret` | set secret file to expose to the build (only if BuildKit enabled) - format (id=mysecret,src=/local/secret) | `false` | N/A | `PARAMETER_SECRETS`
`DOCKER_SECRETS` | -| `security_opts` | set options for security | `false` | N/A | `PARAMETER_SECURITY_OPTS`
`DOCKER_SECURITY_OPTS` | -| `shm_sizes` | set the size of /dev/shm | `false` | N/A | `PARAMETER_SHM_SIZES`
`DOCKER_SHM_SIZES` | -| `squash` | enable squashing newly built layers into a single new layer | `false` | `false` | `PARAMETER_SQUASH`
`DOCKER_SQUASH` | -| `ssh_components` | set SSH agent socket or keys to expose to the build (only if BuildKit enabled) - format (default\|[=\|[,]]) | `false` | N/A | `PARAMETER_SSH_COMPONENTS`
`DOCKER_SSH_COMPONENTS` | -| `stream` | enable stream attaching to the server to negotiate build context | `false` | `false` | `PARAMETER_STREAM`
`DOCKER_STREAM` | -| `tags` | set the tags for the Docker image - format (name:tag) | `true` | N/A | `PARAMETER_TAGS`
`DOCKER_TAGS` | -| `target` | set the target build stage to build | `false` | N/A | `PARAMETER_TARGET`
`DOCKER_TARGET` | -| `ulimits` | set options for ulimits | `false` | N/A | `PARAMETER_ULIMITS`
`DOCKER_ULIMITS` | -| `username` | set user name for communication with the registry | `true` | N/A | `PARAMETER_USERNAME`
`DOCKER_USERNAME` | +| `add_hosts` | set a custom host-to-IP mapping - format (host:ip) | `false` | N/A | `PARAMETER_ADD_HOSTS`
`DOCKER_ADD_HOSTS` | +| `build_args` | set variables to pass to the image at build-time | `false` | N/A | `PARAMETER_BUILD_ARGS`
`DOCKER_BUILD_ARGS` | +| `cache_from` | set of images to consider as cache sources | `false` | N/A | `PARAMETER_CACHE_FROM`
`DOCKER_CACHE_FROM` | +| `cgroup_parent` | set a parent cgroup for the container | `false` | N/A | `PARAMETER_CGROUP_PARENT`
`DOCKER_CGROUP_PARENT` | +| `compress` | enable compressing the build context using gzip | `false` | `false` | `PARAMETER_COMPRESS`
`DOCKER_COMPRESS` | +| `context` | set of files and/or directory to build the image from | `true` | `.` | `PARAMETER_CONTEXT`
`DOCKER_CONTEXT` | +| `cpu` | set the cpu parameter, see [cpu](#cpu) settings below | `false` | N/A | `PARAMETER_CPU`
`DOCKER_CPU` | +| `daemon` | set the daemon parameter, see [daemon](#daemon) settings below | `false` | N/A | `PARAMETER_DAEMON`
`DOCKER_DAEMON` | +| `disable_content_trust` | enable skipping verification of the image | `false` | `true` | `PARAMETER_DISABLE_CONTENT_TRUST`
`DOCKER_DISABLE_CONTENT_TRUST` | +| `dry_run` | enable building the image without publishing | `false` | `false` | `PARAMETER_DRY_RUN`
`DOCKER_DRY_RUN` | +| `file` | set the name of the Dockerfile | `false` | N/A | `PARAMETER_FILE`
`DOCKER_FILE` | +| `force_rm` | enable always removing the intermediate containers after a successful build | `false` | `false` | `PARAMETER_FORCE_RM`
`DOCKER_FORCE_RM` | +| `image_id_file` | set the file to write the image ID to | `false` | N/A | `PARAMETER_IMAGE_ID_FILE`
`DOCKER_IMAGE_ID_FILE` | +| `isolation` | set container isolation technology | `false` | N/A | `PARAMETER_ISOLATION`
`DOCKER_ISOLATION` | +| `labels` | set metadata for an image | `false` | N/A | `PARAMETER_LABELS`
`DOCKER_LABELS` | +| `log_level` | set the log level for the plugin | `true` | `info` | `PARAMETER_LOG_LEVEL`
`DOCKER_LOG_LEVEL` | +| `memory` | set memory limit | `false` | N/A | `PARAMETER_MEMORY`
`DOCKER_MEMORY` | +| `memory_swaps` | set the swap limit equal to memory plus swap: '-1' to enable unlimited swap | `false` | N/A | `PARAMETER_MEMORY_SWAPS`
`DOCKER_MEMORY_SWAPS` | +| `network` | set the networking mode for the RUN instructions during build | `false` | N/A | `PARAMETER_NETWORK`
`DOCKER_NETWORK` | +| `no_cache` | disable caching when building the image | `false` | `false` | `PARAMETER_NO_CACHE`
`DOCKER_NO_CACHE` | +| `output` | set the output destination - format (type=local,dest=path) | `false` | N/A | `PARAMETER_OUTPUTS`
`DOCKER_OUTPUTS` | +| `password` | set password for communication with the registry | `true` | N/A | `PARAMETER_PASSWORD`
`DOCKER_PASSWORD` | +| `platform` | set a platform if server is multi-platform capable | `false` | N/A | `PARAMETER_PLATFORM`
`DOCKER_PLATFORM` | +| `progress` | set type of progress output - options (auto\|plain\|tty) | `false` | N/A | `PARAMETER_PROGRESS`
`DOCKER_PROGRESS` | +| `pull` | enable always attempting to pull a newer version of the image | `false` | `false` | `PARAMETER_PULL`
`DOCKER_PULL` | +| `quiet` | enable suppressing the build output and print image ID on success | `false` | `false` | `PARAMETER_QUIET`
`DOCKER_QUIET` | +| `registry` | set Docker registry address to communicate with | `true` | `index.docker.io` | `PARAMETER_REGISTRY`
`DOCKER_REGISTRY` | +| `remove` | enable removing the intermediate containers after a successful build | `false` | `true` | `PARAMETER_REMOVE`
`DOCKER_REMOVE` | +| `repo` | set Docker repository for the image | `false` | N/A | `PARAMETER_REPO`
`DOCKER_REPO` | +| `secret` | set secret file to expose to the build (only if BuildKit enabled) - format (id=mysecret,src=/local/secret) | `false` | N/A | `PARAMETER_SECRETS`
`DOCKER_SECRETS` | +| `security_opts` | set options for security | `false` | N/A | `PARAMETER_SECURITY_OPTS`
`DOCKER_SECURITY_OPTS` | +| `shm_sizes` | set the size of /dev/shm | `false` | N/A | `PARAMETER_SHM_SIZES`
`DOCKER_SHM_SIZES` | +| `squash` | enable squashing newly built layers into a single new layer | `false` | `false` | `PARAMETER_SQUASH`
`DOCKER_SQUASH` | +| `ssh_components` | set SSH agent socket or keys to expose to the build (only if BuildKit enabled) - format `(default\|[=\|[,]])` | `false` | N/A | `PARAMETER_SSH_COMPONENTS`
`DOCKER_SSH_COMPONENTS` | +| `stream` | enable stream attaching to the server to negotiate build context | `false` | `false` | `PARAMETER_STREAM`
`DOCKER_STREAM` | +| `tags` | set the tags for the Docker image - format (name:tag) | `true` | N/A | `PARAMETER_TAGS`
`DOCKER_TAGS` | +| `target` | set the target build stage to build | `false` | N/A | `PARAMETER_TARGET`
`DOCKER_TARGET` | +| `ulimits` | set options for ulimits | `false` | N/A | `PARAMETER_ULIMITS`
`DOCKER_ULIMITS` | +| `username` | set user name for communication with the registry | `true` | N/A | `PARAMETER_USERNAME`
`DOCKER_USERNAME` | ### CPU