--- description: components and formatting examples used in Docker's docs title: Code blocks toc_max: 3 --- # Code blocks Rouge provides lots of different code block "hints". If you leave off the hint, it tries to guess and sometimes gets it wrong. These are just a few hints that we use often. ## Raw Use the {% raw %}`{% raw %}`{% endraw %} markup tag to prevent Liquid from interpreting double braces as templating language. {% raw %} ```` {​% raw %} ```none generic code block without syntax highlighting $ some command with {{double braces}} $ some other command ``` {​% endraw %} ```` {% endraw %} ## Bash Use the `bash` language code block when you want to a Bash script: ```bash #!/usr/bin/bash echo "deb https://packages.docker.com/1.12/apt/repo ubuntu-trusty main" | sudo tee /etc/apt/sources.list.d/docker.list ``` If you want to illustrate an interactive shell, use `console` instead. In cases where you use `console`, make sure to add a dollar character for the user sign: ```console $ echo "deb https://packages.docker.com/1.12/apt/repo ubuntu-trusty main" | sudo tee /etc/apt/sources.list.d/docker.list ``` ## Go ```go incoming := map[string]interface{}{ "asdf": 1, "qwer": []interface{}{}, "zxcv": []interface{}{ map[string]interface{}{}, true, int(1e9), "tyui", }, } ``` ## PowerShell ```powershell Install-Module DockerMsftProvider -Force Install-Package Docker -ProviderName DockerMsftProvider -Force [System.Environment]::SetEnvironmentVariable("DOCKER_FIPS", "1", "Machine") Expand-Archive docker-18.09.1.zip -DestinationPath $Env:ProgramFiles -Force ``` ## Python ```python return html.format(name=os.getenv('NAME', "world"), hostname=socket.gethostname(), visits=visits) ``` ## Ruby ```ruby docker_service 'default' do action [:create, :start] end ``` ## JSON ```json "server": { "http_addr": ":4443", "tls_key_file": "./fixtures/notary-server.key", "tls_cert_file": "./fixtures/notary-server.crt" } ``` #### HTML ```html Welcome to nginx! ``` ## Markdown ```markdown # Hello ``` If you want to include a triple-fenced code block inside your code block, you can wrap your block in a quadruple-fenced code block: `````markdown ````markdown # Hello ```go log.Println("did something") ``` ```` ````` ## ini ```ini [supervisord] nodaemon=true [program:sshd] command=/usr/sbin/sshd -D ``` ## Dockerfile ```dockerfile # syntax=docker/dockerfile:1 FROM ubuntu RUN apt-key adv --keyserver hkp://p80.pool.sks-keyservers.net:80 --recv-keys B97B0AFCAA1A47F044F244A07FCC7D46ACCC4CF8 RUN echo "deb http://apt.postgresql.org/pub/repos/apt/ precise-pgdg main" > /etc/apt/sources.list.d/pgdg.list RUN apt-get update && apt-get install -y python-software-properties software-properties-common postgresql-9.3 postgresql-client-9.3 postgresql-contrib-9.3 # Note: The official Debian and Ubuntu images automatically ``apt-get clean`` # after each ``apt-get`` USER postgres RUN /etc/init.d/postgresql start &&\ psql --command "CREATE USER docker WITH SUPERUSER PASSWORD 'docker';" &&\ createdb -O docker docker RUN echo "host all all 0.0.0.0/0 md5" >> /etc/postgresql/9.3/main/pg_hba.conf RUN echo "listen_addresses='*'" >> /etc/postgresql/9.3/main/postgresql.conf EXPOSE 5432 VOLUME ["/etc/postgresql", "/var/log/postgresql", "/var/lib/postgresql"] CMD ["/usr/lib/postgresql/9.3/bin/postgres", "-D", "/var/lib/postgresql/9.3/main", "-c", "config_file=/etc/postgresql/9.3/main/postgresql.conf"] ``` ## YAML ```yaml authorizedkeys: image: dockercloud/authorizedkeys deployment_strategy: every_node autodestroy: always environment: - AUTHORIZED_KEYS=ssh-rsa AAAAB3Nsomelongsshkeystringhereu9UzQbVKy9o00NqXa5jkmZ9Yd0BJBjFmb3WwUR8sJWZVTPFL volumes: /root:/user:rw ```