浏览代码

Replace backtick code blocks with indentation

Signed-off-by: Aanand Prasad <[email protected]>
Aanand Prasad 10 年之前
父节点
当前提交
511fc4a05c
共有 3 个文件被更改,包括 166 次插入197 次删除
  1. 86 106
      docs/extends.md
  2. 23 27
      docs/index.md
  3. 57 64
      docs/wordpress.md

+ 86 - 106
docs/extends.md

@@ -28,25 +28,21 @@ the configuration around.
 When defining any service in `docker-compose.yml`, you can declare that you are
 extending another service like this:
 
-```yaml
-web:
-  extends:
-    file: common-services.yml
-    service: webapp
-```
+    web:
+      extends:
+        file: common-services.yml
+        service: webapp
 
 This instructs Compose to re-use the configuration for the `webapp` service
 defined in the `common-services.yml` file. Suppose that `common-services.yml`
 looks like this:
 
-```yaml
-webapp:
-  build: .
-  ports:
-    - "8000:8000"
-  volumes:
-    - "/data"
-```
+    webapp:
+      build: .
+      ports:
+        - "8000:8000"
+      volumes:
+        - "/data"
 
 In this case, you'll get exactly the same result as if you wrote
 `docker-compose.yml` with that `build`, `ports` and `volumes` configuration
@@ -55,31 +51,27 @@ defined directly under `web`.
 You can go further and define (or re-define) configuration locally in
 `docker-compose.yml`:
 
-```yaml
-web:
-  extends:
-    file: common-services.yml
-    service: webapp
-  environment:
-    - DEBUG=1
-  cpu_shares: 5
-```
+    web:
+      extends:
+        file: common-services.yml
+        service: webapp
+      environment:
+        - DEBUG=1
+      cpu_shares: 5
 
 You can also write other services and link your `web` service to them:
 
-```yaml
-web:
-  extends:
-    file: common-services.yml
-    service: webapp
-  environment:
-    - DEBUG=1
-  cpu_shares: 5
-  links:
-    - db
-db:
-  image: postgres
-```
+    web:
+      extends:
+        file: common-services.yml
+        service: webapp
+      environment:
+        - DEBUG=1
+      cpu_shares: 5
+      links:
+        - db
+    db:
+      image: postgres
 
 For full details on how to use `extends`, refer to the [reference](#reference).
 
@@ -271,103 +263,91 @@ For single-value options like `image`, `command` or `mem_limit`, the new value
 replaces the old value. **This is the default behaviour - all exceptions are
 listed below.**
 
-```yaml
-# original service
-command: python app.py
+    # original service
+    command: python app.py
 
-# local service
-command: python otherapp.py
+    # local service
+    command: python otherapp.py
 
-# result
-command: python otherapp.py
-```
+    # result
+    command: python otherapp.py
 
 In the case of `build` and `image`, using one in the local service causes
 Compose to discard the other, if it was defined in the original service.
 
-```yaml
-# original service
-build: .
+    # original service
+    build: .
 
-# local service
-image: redis
+    # local service
+    image: redis
 
-# result
-image: redis
-```
+    # result
+    image: redis
 
-```yaml
-# original service
-image: redis
+    # original service
+    image: redis
 
-# local service
-build: .
+    # local service
+    build: .
 
-# result
-build: .
-```
+    # result
+    build: .
 
 For the **multi-value options** `ports`, `expose`, `external_links`, `dns` and
 `dns_search`, Compose concatenates both sets of values:
 
-```yaml
-# original service
-expose:
-  - "3000"
+    # original service
+    expose:
+      - "3000"
 
-# local service
-expose:
-  - "4000"
-  - "5000"
+    # local service
+    expose:
+      - "4000"
+      - "5000"
 
-# result
-expose:
-  - "3000"
-  - "4000"
-  - "5000"
-```
+    # result
+    expose:
+      - "3000"
+      - "4000"
+      - "5000"
 
 In the case of `environment` and `labels`, Compose "merges" entries together
 with locally-defined values taking precedence:
 
-```yaml
-# original service
-environment:
-  - FOO=original
-  - BAR=original
+    # original service
+    environment:
+      - FOO=original
+      - BAR=original
 
-# local service
-environment:
-  - BAR=local
-  - BAZ=local
+    # local service
+    environment:
+      - BAR=local
+      - BAZ=local
 
-# result
-environment:
-  - FOO=original
-  - BAR=local
-  - BAZ=local
-```
+    # result
+    environment:
+      - FOO=original
+      - BAR=local
+      - BAZ=local
 
 Finally, for `volumes` and `devices`, Compose "merges" entries together with
 locally-defined bindings taking precedence:
 
-```yaml
-# original service
-volumes:
-  - /original-dir/foo:/foo
-  - /original-dir/bar:/bar
-
-# local service
-volumes:
-  - /local-dir/bar:/bar
-  - /local-dir/baz/:baz
-
-# result
-volumes:
-  - /original-dir/foo:/foo
-  - /local-dir/bar:/bar
-  - /local-dir/baz/:baz
-```
+    # original service
+    volumes:
+      - /original-dir/foo:/foo
+      - /original-dir/bar:/bar
+
+    # local service
+    volumes:
+      - /local-dir/bar:/bar
+      - /local-dir/baz/:baz
+
+    # result
+    volumes:
+      - /original-dir/foo:/foo
+      - /local-dir/bar:/bar
+      - /local-dir/baz/:baz
 
 ## Compose documentation
 

+ 23 - 27
docs/index.md

@@ -29,18 +29,16 @@ they can be run together in an isolated environment:
 
 A `docker-compose.yml` looks like this:
 
-```yaml
-web:
-  build: .
-  ports:
-   - "5000:5000"
-  volumes:
-   - .:/code
-  links:
-   - redis
-redis:
-  image: redis
-```
+    web:
+      build: .
+      ports:
+       - "5000:5000"
+      volumes:
+       - .:/code
+      links:
+       - redis
+    redis:
+      image: redis
 
 Compose has commands for managing the whole lifecycle of your application:
 
@@ -79,21 +77,19 @@ Next, you'll want to make a directory for the project:
 Inside this directory, create `app.py`, a simple web app that uses the Flask
 framework and increments a value in Redis:
 
-```python
-from flask import Flask
-from redis import Redis
-import os
-app = Flask(__name__)
-redis = Redis(host='redis', port=6379)
-
[email protected]('/')
-def hello():
-    redis.incr('hits')
-    return 'Hello World! I have been seen %s times.' % redis.get('hits')
-
-if __name__ == "__main__":
-    app.run(host="0.0.0.0", debug=True)
-```
+    from flask import Flask
+    from redis import Redis
+    import os
+    app = Flask(__name__)
+    redis = Redis(host='redis', port=6379)
+
+    @app.route('/')
+    def hello():
+        redis.incr('hits')
+        return 'Hello World! I have been seen %s times.' % redis.get('hits')
+
+    if __name__ == "__main__":
+        app.run(host="0.0.0.0", debug=True)
 
 Next, define the Python dependencies in a file called `requirements.txt`:
 

+ 57 - 64
docs/wordpress.md

@@ -32,10 +32,8 @@ Dockerfiles, see the
 [Dockerfile reference](http://docs.docker.com/reference/builder/). In this case,
 your Dockerfile should be:
 
-```
-FROM orchardup/php5
-ADD . /code
-```
+    FROM orchardup/php5
+    ADD . /code
 
 This tells Docker how to build an image defining a container that contains PHP
 and Wordpress. 
@@ -43,74 +41,69 @@ and Wordpress.
 Next you'll create a `docker-compose.yml` file that will start your web service
 and a separate MySQL instance:
 
-```
-web:
-  build: .
-  command: php -S 0.0.0.0:8000 -t /code
-  ports:
-    - "8000:8000"
-  links:
-    - db
-  volumes:
-    - .:/code
-db:
-  image: orchardup/mysql
-  environment:
-    MYSQL_DATABASE: wordpress
-```
+    web:
+      build: .
+      command: php -S 0.0.0.0:8000 -t /code
+      ports:
+        - "8000:8000"
+      links:
+        - db
+      volumes:
+        - .:/code
+    db:
+      image: orchardup/mysql
+      environment:
+        MYSQL_DATABASE: wordpress
 
 Two supporting files are needed to get this working - first, `wp-config.php` is
 the standard Wordpress config file with a single change to point the database
 configuration at the `db` container:
 
-```
-<?php
-define('DB_NAME', 'wordpress');
-define('DB_USER', 'root');
-define('DB_PASSWORD', '');
-define('DB_HOST', "db:3306");
-define('DB_CHARSET', 'utf8');
-define('DB_COLLATE', '');
-
-define('AUTH_KEY',         'put your unique phrase here');
-define('SECURE_AUTH_KEY',  'put your unique phrase here');
-define('LOGGED_IN_KEY',    'put your unique phrase here');
-define('NONCE_KEY',        'put your unique phrase here');
-define('AUTH_SALT',        'put your unique phrase here');
-define('SECURE_AUTH_SALT', 'put your unique phrase here');
-define('LOGGED_IN_SALT',   'put your unique phrase here');
-define('NONCE_SALT',       'put your unique phrase here');
-
-$table_prefix  = 'wp_';
-define('WPLANG', '');
-define('WP_DEBUG', false);
-
-if ( !defined('ABSPATH') )
-    define('ABSPATH', dirname(__FILE__) . '/');
-
-require_once(ABSPATH . 'wp-settings.php');
-```
+    <?php
+    define('DB_NAME', 'wordpress');
+    define('DB_USER', 'root');
+    define('DB_PASSWORD', '');
+    define('DB_HOST', "db:3306");
+    define('DB_CHARSET', 'utf8');
+    define('DB_COLLATE', '');
+
+    define('AUTH_KEY',         'put your unique phrase here');
+    define('SECURE_AUTH_KEY',  'put your unique phrase here');
+    define('LOGGED_IN_KEY',    'put your unique phrase here');
+    define('NONCE_KEY',        'put your unique phrase here');
+    define('AUTH_SALT',        'put your unique phrase here');
+    define('SECURE_AUTH_SALT', 'put your unique phrase here');
+    define('LOGGED_IN_SALT',   'put your unique phrase here');
+    define('NONCE_SALT',       'put your unique phrase here');
+
+    $table_prefix  = 'wp_';
+    define('WPLANG', '');
+    define('WP_DEBUG', false);
+
+    if ( !defined('ABSPATH') )
+        define('ABSPATH', dirname(__FILE__) . '/');
+
+    require_once(ABSPATH . 'wp-settings.php');
 
 Second, `router.php` tells PHP's built-in web server how to run Wordpress:
 
-```
-<?php
-
-$root = $_SERVER['DOCUMENT_ROOT'];
-chdir($root);
-$path = '/'.ltrim(parse_url($_SERVER['REQUEST_URI'])['path'],'/');
-set_include_path(get_include_path().':'.__DIR__);
-if(file_exists($root.$path))
-{
-    if(is_dir($root.$path) && substr($path,strlen($path) - 1, 1) !== '/')
-        $path = rtrim($path,'/').'/index.php';
-    if(strpos($path,'.php') === false) return false;
-    else {
-        chdir(dirname($root.$path));
-        require_once $root.$path;
-    }
-}else include_once 'index.php';
-```
+    <?php
+
+    $root = $_SERVER['DOCUMENT_ROOT'];
+    chdir($root);
+    $path = '/'.ltrim(parse_url($_SERVER['REQUEST_URI'])['path'],'/');
+    set_include_path(get_include_path().':'.__DIR__);
+    if(file_exists($root.$path))
+    {
+        if(is_dir($root.$path) && substr($path,strlen($path) - 1, 1) !== '/')
+            $path = rtrim($path,'/').'/index.php';
+        if(strpos($path,'.php') === false) return false;
+        else {
+            chdir(dirname($root.$path));
+            require_once $root.$path;
+        }
+    }else include_once 'index.php';
+
 ### Build the project
 
 With those four files in place, run `docker-compose up` inside your Wordpress