Skip to content

Commit b2b1558

Browse files
cbeneranco74
authored andcommitted
README: escape dollars to avoid math rendering
GitHub markdown renders $TeX math$ [since mid-2022](https://github.blog/2022-05-19-math-support-in-markdown/), which currently messes up the passage about $VARIABLE syntaxes on the rendered README.
1 parent 60168ef commit b2b1558

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -223,13 +223,13 @@ For example, suppose the shell contains EXTERNAL_PORT=5000 and you supply this c
223223
env:
224224
EXTERNAL_PORT: $EXTERNAL_PORT
225225
````
226-
When you run Skipper command with this configuration, Skipper looks for the EXTERNAL_PORT environment variable in the shell and substitutes its value in.In this example, Skipper resolves the $EXTERNAL_PORT to "5000" and will set EXTERNAL_PORT=5000 environment in the container.
226+
When you run Skipper command with this configuration, Skipper looks for the EXTERNAL_PORT environment variable in the shell and substitutes its value in.In this example, Skipper resolves the `$EXTERNAL_PORT` to "5000" and will set EXTERNAL_PORT=5000 environment in the container.
227227

228228
If an environment variable is not set, Skipper substitutes with an empty string.
229229

230-
Both $VARIABLE and ${VARIABLE} syntax are supported. Extended shell-style features, such as ${VARIABLE-default} and ${VARIABLE/foo/bar}, are not supported.
230+
Both `$VARIABLE` and `${VARIABLE}` syntax are supported. Extended shell-style features, such as `${VARIABLE-default}` and `${VARIABLE/foo/bar}`, are not supported.
231231

232-
You can use a $$ (double-dollar sign) when your configuration needs a literal dollar sign. This also prevents Skipper from interpolating a value, so a $$ allows you to refer to environment variables that you don’t want processed by Skipper.
232+
You can use a `$$` (double-dollar sign) when your configuration needs a literal dollar sign. This also prevents Skipper from interpolating a value, so a `$$` allows you to refer to environment variables that you don’t want processed by Skipper.
233233
````
234234
env:
235235
VAR: $$VAR_NOT_INTERPOLATED
@@ -275,4 +275,4 @@ workdir: $PWD
275275

276276
### Skipper environment variables
277277
Skipper sets environemnt variables to inform the user about the underline system:
278-
CONTAINER_RUNTIME_COMMAND - The container conmmand used to run the skipper container. podman/docker
278+
CONTAINER_RUNTIME_COMMAND - The container conmmand used to run the skipper container. podman/docker

0 commit comments

Comments
 (0)