Fix formatting for Markdown files containing `{{`

They're usually examples of Go-style text templates.  But, Liquid templating is treating them as variable substitutions.  E.g., in `engine/reference/commandline/ps.md`:

```bash
$ docker ps --filter volume=remote-volume --format "table {{.ID}}\t{{.Mounts}}"
```

is rendered as:

```bash
$ docker ps --filter volume=remote-volume --format "table \t"
```

Solution is to wrap entire files in `{% raw %} ... {% endraw %}` blocks.
This commit is contained in:
Benjamin R. Haskell 2016-10-05 01:58:24 -04:00
parent a0e7eb56d0
commit b3a620808a
35 changed files with 140 additions and 0 deletions

View File

@ -1,3 +1,5 @@
{% raw %}
# Nodes
## Node
@ -374,3 +376,5 @@ Available in Docker Cloud's **REST API**
Parameter | Description
--------- | -----------
uuid | The UUID of the node to terminate
{% endraw %}

View File

@ -1,3 +1,5 @@
{% raw %}
# Stacks
## Stack
@ -566,3 +568,5 @@ Available in Docker Cloud's **REST API**
Parameter | Description
--------- | -----------
uuid | The UUID of the stack to terminate
{% endraw %}

View File

@ -9,6 +9,8 @@ menu:
title: Format command and log output
---
{% raw %}
# Formatting reference
Docker uses [Go templates](https://golang.org/pkg/text/template/) to allow users manipulate the output format
@ -64,3 +66,5 @@ Title capitalizes a string.
Upper turns a string into its upper case representation.
$ docker inspect --format "{{upper .Name}}" container
{% endraw %}

View File

@ -10,6 +10,8 @@ menu:
title: Fluentd logging driver
---
{% raw %}
# Fluentd logging driver
The `fluentd` logging driver sends container logs to the
@ -113,3 +115,5 @@ aggregate store.
3. Start one or more containers with the `fluentd` logging driver:
$ docker run --log-driver=fluentd your/application
{% endraw %}

View File

@ -11,6 +11,8 @@ menu:
title: Log tags for logging driver
---
{% raw %}
# Log Tags
The `tag` log option specifies how to format a tag that identifies the
@ -66,3 +68,5 @@ Apr 1 15:22:17 ip-10-27-39-73 docker/logtester.1234[45499]: + exec app
Apr 1 15:22:17 ip-10-27-39-73 docker/logtester.1234[45499]: 2016-04-01 15:22:17.075416751 +0000 UTC stderr msg: 1
```
{% endraw %}

View File

@ -11,6 +11,8 @@ menu:
title: Configuring Logging Drivers
---
{% raw %}
# Configure logging drivers
The container can have a different logging driver than the Docker daemon. Use
@ -305,3 +307,5 @@ The Google Cloud Logging driver supports the following options:
For detailed information about working with this logging driver, see the
[Google Cloud Logging driver](gcplogs.md). reference documentation.
{% endraw %}

View File

@ -10,6 +10,8 @@ menu:
title: Splunk logging driver
---
{% raw %}
# Splunk logging driver
The `splunk` logging driver sends container logs to
@ -67,3 +69,5 @@ The `SplunkServerDefaultCert` is automatically generated by Splunk certificates.
--env "TEST=false"
--label location=west
your/application
{% endraw %}

View File

@ -11,6 +11,8 @@ menu:
title: Deprecated Engine Features
---
{% raw %}
# Deprecated Engine Features
The following list of features are deprecated in Engine.
@ -187,3 +189,5 @@ Since 1.9, Docker Content Trust Offline key has been renamed to Root key and the
- DOCKER_CONTENT_TRUST_OFFLINE_PASSPHRASE is now named DOCKER_CONTENT_TRUST_ROOT_PASSPHRASE
- DOCKER_CONTENT_TRUST_TAGGING_PASSPHRASE is now named DOCKER_CONTENT_TRUST_REPOSITORY_PASSPHRASE
{% endraw %}

View File

@ -9,6 +9,8 @@ menu:
title: Remote API v1.18
---
{% raw %}
# Docker Remote API v1.18
## 1. Brief introduction
@ -2133,3 +2135,5 @@ To set cross origin requests to the remote api please give values to
default or blank means CORS disabled
$ docker -d -H="192.168.1.9:2375" --api-cors-header="http://foo.bar"
{% endraw %}

View File

@ -9,6 +9,8 @@ menu:
title: Remote API v1.19
---
{% raw %}
# Docker Remote API v1.19
## 1. Brief introduction
@ -2213,3 +2215,5 @@ To set cross origin requests to the remote api please give values to
default or blank means CORS disabled
$ docker -d -H="192.168.1.9:2375" --api-cors-header="http://foo.bar"
{% endraw %}

View File

@ -9,6 +9,8 @@ menu:
title: Remote API v1.20
---
{% raw %}
# Docker Remote API v1.20
## 1. Brief introduction
@ -2364,3 +2366,5 @@ To set cross origin requests to the remote api please give values to
default or blank means CORS disabled
$ dockerd -H="192.168.1.9:2375" --api-cors-header="http://foo.bar"
{% endraw %}

View File

@ -9,6 +9,8 @@ menu:
title: Remote API v1.21
---
{% raw %}
# Docker Remote API v1.21
## 1. Brief introduction
@ -2935,3 +2937,5 @@ To set cross origin requests to the remote api please give values to
default or blank means CORS disabled
$ dockerd -H="192.168.1.9:2375" --api-cors-header="http://foo.bar"
{% endraw %}

View File

@ -9,6 +9,8 @@ menu:
title: Remote API v1.22
---
{% raw %}
# Docker Remote API v1.22
## 1. Brief introduction
@ -3271,3 +3273,5 @@ To set cross origin requests to the remote api please give values to
default or blank means CORS disabled
$ dockerd -H="192.168.1.9:2375" --api-cors-header="http://foo.bar"
{% endraw %}

View File

@ -9,6 +9,8 @@ menu:
title: Remote API v1.23
---
{% raw %}
# Docker Remote API v1.23
## 1. Brief introduction
@ -3387,3 +3389,5 @@ To set cross origin requests to the remote api please give values to
default or blank means CORS disabled
$ dockerd -H="192.168.1.9:2375" --api-cors-header="http://foo.bar"
{% endraw %}

View File

@ -9,6 +9,8 @@ menu:
title: Remote API v1.24
---
{% raw %}
# Docker Remote API v1.24
# 1. Brief introduction
@ -5245,3 +5247,5 @@ To set cross origin requests to the remote api please give values to
default or blank means CORS disabled
$ dockerd -H="192.168.1.9:2375" --api-cors-header="http://foo.bar"
{% endraw %}

View File

@ -10,6 +10,8 @@ menu:
title: Remote API v1.25
---
{% raw %}
# Docker Remote API v1.25
# 1. Brief introduction
@ -5281,3 +5283,5 @@ To set cross origin requests to the remote api please give values to
default or blank means CORS disabled
$ dockerd -H="192.168.1.9:2375" --api-cors-header="http://foo.bar"
{% endraw %}

View File

@ -9,6 +9,8 @@ menu:
title: Use the Docker command line
---
{% raw %}
# Use the Docker command line
To list available commands, either run `docker` with no parameters
@ -222,3 +224,5 @@ Sometimes, multiple options can call for a more complex value string as for
Options like `--name=""` expect a string, and they
can only be specified once. Options like `-c=0`
expect an integer, and they can only be specified once.
{% endraw %}

View File

@ -8,6 +8,8 @@ menu:
title: commit
---
{% raw %}
# commit
```markdown
@ -84,3 +86,5 @@ created. Supported `Dockerfile` instructions:
89373736e2e7 testimage:version4 "apachectl -DFOREGROU" 3 seconds ago Up 2 seconds 80/tcp
c3f279d17e0a ubuntu:12.04 /bin/bash 7 days ago Up 25 hours
197387f1b436 ubuntu:12.04 /bin/bash 7 days ago Up 25 hours
{% endraw %}

View File

@ -8,6 +8,8 @@ menu:
title: images
---
{% raw %}
# images
```markdown
@ -274,3 +276,5 @@ can use:
746b819f315e postgres 9.3
746b819f315e postgres 9.3.5
746b819f315e postgres latest
{% endraw %}

View File

@ -8,6 +8,8 @@ menu:
title: inspect
---
{% raw %}
# inspect
```markdown
@ -80,3 +82,5 @@ Docker adds a template function, `json`, which can be applied to get
results in JSON format.
$ docker inspect --format='{{json .Config}}' $INSTANCE_ID
{% endraw %}

View File

@ -8,6 +8,8 @@ menu:
title: node inspect
---
{% raw %}
**Warning:** this command is part of the Swarm management feature introduced in Docker 1.12, and might be subject to non backward-compatible changes.
# node inspect
@ -126,3 +128,5 @@ Example output:
* [node ps](node_ps.md)
* [node ls](node_ls.md)
* [node rm](node_rm.md)
{% endraw %}

View File

@ -8,6 +8,8 @@ menu:
title: ps
---
{% raw %}
# ps
```markdown
@ -366,3 +368,5 @@ a87ecb4f327c com.docker.swarm.node=ubuntu,com.docker.swarm.storage=ssd
c1d3b0166030 com.docker.swarm.node=debian,com.docker.swarm.cpu=6
41d50ecd2f57 com.docker.swarm.node=fedora,com.docker.swarm.cpu=3,com.docker.swarm.storage=ssd
```
{% endraw %}

View File

@ -8,6 +8,8 @@ menu:
title: service inspect
---
{% raw %}
**Warning:** this command is part of the Swarm management feature introduced in Docker 1.12, and might be subject to non backward-compatible changes.
# service inspect
@ -153,3 +155,5 @@ $ docker service inspect --format='{{.Spec.Mode.Replicated.Replicas}}' redis
* [service scale](service_scale.md)
* [service ps](service_ps.md)
* [service update](service_update.md)
{% endraw %}

View File

@ -8,6 +8,8 @@ menu:
title: version
---
{% raw %}
# version
```markdown
@ -56,3 +58,5 @@ describes all the details of the format.
$ docker version --format '{{json .}}'
{"Client":{"Version":"1.8.0","ApiVersion":"1.20","GitCommit":"f5bae0a","GoVersion":"go1.4.2","Os":"linux","Arch":"amd64","BuildTime":"Tue Jun 23 17:56:00 UTC 2015"},"ServerOK":true,"Server":{"Version":"1.8.0","ApiVersion":"1.20","GitCommit":"f5bae0a","GoVersion":"go1.4.2","Os":"linux","Arch":"amd64","KernelVersion":"3.13.2-gentoo","BuildTime":"Tue Jun 23 17:56:00 UTC 2015"}}
{% endraw %}

View File

@ -8,6 +8,8 @@ menu:
title: volume inspect
---
{% raw %}
# volume inspect
```markdown
@ -49,3 +51,5 @@ Example output:
* [volume ls](volume_ls.md)
* [volume rm](volume_rm.md)
* [Understand Data Volumes](../../tutorials/dockervolumes.md)
{% endraw %}

View File

@ -9,6 +9,8 @@ menu:
title: Docker run reference
---
{% raw %}
# Docker run reference
Docker runs processes in isolated containers. A container is a process
@ -1551,3 +1553,5 @@ root directory (`/`), but the developer can set a different default with the
Dockerfile `WORKDIR` command. The operator can override this with:
-w="": Working directory inside the container
{% endraw %}

View File

@ -12,6 +12,8 @@ menu:
title: Swarm administration guide
---
{% raw %}
# Administer and maintain a swarm of Docker Engines
When you run a swarm of Docker Engines, **manager nodes** are the key components
@ -262,3 +264,5 @@ The `--force-new-cluster` flag puts the Docker Engine into swarm mode as a
manager node of a single-node swarm. It discards swarm membership information
that existed before the loss of the quorum but it retains data necessary to the
Swarm such as services, tasks and the list of worker nodes.
{% endraw %}

View File

@ -15,6 +15,8 @@ menu:
title: Use swarm mode routing mesh
---
{% raw %}
# Use swarm mode routing mesh
Docker Engine swarm mode makes it easy to publish ports for services to make
@ -135,3 +137,5 @@ To learn more about HAProxy, see the [HAProxy documentation](https://cbonte.gith
## Learn more
* [Deploy services to a swarm](services.md)
{% endraw %}

View File

@ -13,6 +13,8 @@ menu:
title: Attach services to an overlay network
---
{% raw %}
# Attach services to an overlay network
Docker Engine swarm mode natively supports **overlay networks**, so you can
@ -309,3 +311,5 @@ is not the right tool to confirm VIP connectivity.
* [Swarm administration guide](admin_guide.md)
* [Docker Engine command line reference](../reference/commandline/index.md)
* [Swarm mode tutorial](swarm-tutorial/index.md)
{% endraw %}

View File

@ -12,6 +12,8 @@ menu:
title: Network containers
---
{% raw %}
# Network containers
If you are working your way through the user guide, you just built and ran a
@ -261,3 +263,5 @@ The `ping` shows it is contacting a different IP address, the address on the `my
## Next steps
Now that you know how to network containers, see [how to manage data in containers](dockervolumes.md).
{% endraw %}

View File

@ -12,6 +12,8 @@ menu:
title: Run a simple application
---
{% raw %}
# Run a simple application
In the ["*Hello world in a container*"](dockerizing.md) you launched your
@ -320,3 +322,5 @@ Until now you've only used images that you've downloaded from Docker Hub. Next,
you can get introduced to building and sharing our own images.
Go to [Working with Docker Images](dockerimages.md).
{% endraw %}

View File

@ -10,6 +10,8 @@ menu:
title: Legacy container links
---
{% raw %}
# Legacy container links
The information in this section explains legacy container links within the Docker default bridge. This is a `bridge` network named `bridge` created automatically when you install Docker.
@ -370,3 +372,5 @@ allowing linked communication to continue.
172.17.0.9 db
# Related information
{% endraw %}

View File

@ -9,6 +9,8 @@ menu:
title: Work with network commands
---
{% raw %}
# Work with network commands
This article provides examples of the network subcommands you can use to
@ -926,3 +928,5 @@ f7ab26d71dbd bridge bridge
* [network disconnect](../../reference/commandline/network_disconnect.md)
* [network ls](../../reference/commandline/network_ls.md)
* [network rm](../../reference/commandline/network_rm.md)
{% endraw %}

View File

@ -9,6 +9,8 @@ menu:
title: inspect
---
{% raw %}
# inspect
Usage: docker-machine inspect [OPTIONS] [arg...]
@ -87,3 +89,5 @@ While this is usable, it's not very human-readable. For this reason, there is
"SwarmHost": "tcp://0.0.0.0:3376",
"SwarmMaster": false
}
{% endraw %}

View File

@ -8,6 +8,8 @@ menu:
title: ls
---
{% raw %}
# ls
Usage: docker-machine ls [OPTIONS] [arg...]
@ -106,3 +108,5 @@ To list all machine names with their driver in a table format you can use:
NAME DRIVER
default virtualbox
ec2 amazonec2
{% endraw %}