Docs: Inline docker-compose.yaml files in the documentation

.github/workflows/docs.yml

@@ -14,5 +14,5 @@ jobs:
       - uses: actions/setup-python@v2
         with:
           python-version: 3.x
-      - run: pip install mkdocs-material
+      - run: pip install mkdocs-material mkdocs-include-markdown-plugin
       - run: mkdocs gh-deploy --force

docs/contribute.md

@@ -59,6 +59,8 @@ folder of the GitHub repository.
 
 In order to contribute to the documentation you can fork the repository and edit the markdown files in the browser.
 
+Now install mkdocs and dependencies: `pip install mkdocs-material mkdocs-include-markdown-plugin`.
+
 If you want to test the documentation locally run `mkdocs serve` from the project root.
 
 ## Contribute Translations

docs/install/docker.md

@@ -65,47 +65,11 @@ This configuration exposes the application through an nginx web server on port 8
 wget https://raw.githubusercontent.com/vabene1111/recipes/develop/docs/install/docker/plain/docker-compose.yml
 ```
 
-```yaml
+{%
-version: "3"
+  include "./docker/plain/docker-compose.yml"
-services:
+  start="```yaml"
-  db_recipes:
+  end="```\n"
-    restart: always
+%}
-    image: postgres:11-alpine
-    volumes:
-      - ./postgresql:/var/lib/postgresql/data
-    env_file:
-      - ./.env
-
-  web_recipes:
-    image: vabene1111/recipes
-    restart: always
-    env_file:
-      - ./.env
-    volumes:
-      - staticfiles:/opt/recipes/staticfiles
-      - nginx_config:/opt/recipes/nginx/conf.d
-      - ./mediafiles:/opt/recipes/mediafiles
-    depends_on:
-      - db_recipes
-
-  nginx_recipes:
-    image: nginx:mainline-alpine
-    restart: always
-    ports:
-      - 80:80
-    env_file:
-      - ./.env
-    depends_on:
-      - web_recipes
-    volumes:
-      - nginx_config:/etc/nginx/conf.d:ro
-      - staticfiles:/static
-      - ./mediafiles:/media
-
-volumes:
-  nginx_config:
-  staticfiles:
-```
 
 ### Reverse Proxy
 
@@ -123,62 +87,11 @@ If you use traefik, this configuration is the one for you.
 wget https://raw.githubusercontent.com/vabene1111/recipes/develop/docs/install/docker/traefik-nginx/docker-compose.yml
 ```
 
-```yaml
+{%
-version: "3"
+  include "./docker/traefik-nginx/docker-compose.yml"
-services:
+  start="```yaml"
-  db_recipes:
+  end="```\n"
-    restart: always
+%}
-    image: postgres:11-alpine
-    volumes:
-      - ./postgresql:/var/lib/postgresql/data
-    env_file:
-      - ./.env
-    networks:
-      - default
-
-  web_recipes:
-    image: vabene1111/recipes
-    restart: always
-    env_file:
-      - ./.env
-    volumes:
-      - staticfiles:/opt/recipes/staticfiles
-      - nginx_config:/opt/recipes/nginx/conf.d
-      - ./mediafiles:/opt/recipes/mediafiles
-    depends_on:
-      - db_recipes
-    networks:
-      - default
-
-  nginx_recipes:
-    image: nginx:mainline-alpine
-    restart: always
-    env_file:
-      - ./.env
-    volumes:
-      - nginx_config:/etc/nginx/conf.d:ro
-      - staticfiles:/static
-      - ./mediafiles:/media
-    labels: # traefik example labels
-      - "traefik.enable=true"
-      - "traefik.http.routers.recipes.rule=Host(`recipes.mydomain.com`, `recipes.myotherdomain.com`)"
-      - "traefik.http.routers.recipes.entrypoints=web_secure" # your https endpoint
-      - "traefik.http.routers.recipes.tls.certresolver=le_resolver" # your cert resolver
-    depends_on:
-      - web_recipes
-    networks:
-      - default
-      - traefik
-
-networks:
-  default:
-  traefik: # This is you external traefik network
-    external: true
-
-volumes:
-  nginx_config:
-  staticfiles:
-```
 
 #### nginx-proxy
 
@@ -198,58 +111,11 @@ LETSENCRYPT_EMAIL=
 wget https://raw.githubusercontent.com/vabene1111/recipes/develop/docs/install/docker/nginx-proxy/docker-compose.yml
 ```
 
-```yaml
+{%
-version: "3"
+  include "./docker/nginx-proxy/docker-compose.yml"
-services:
+  start="```yaml"
-  db_recipes:
+  end="```\n"
-    restart: always
+%}
-    image: postgres:11-alpine
-    volumes:
-      - ./postgresql:/var/lib/postgresql/data
-    env_file:
-      - ./.env
-    networks:
-      - default
-
-  web_recipes:
-    image: vabene1111/recipes
-    restart: always
-    env_file:
-      - ./.env
-    volumes:
-      - staticfiles:/opt/recipes/staticfiles
-      - nginx_config:/opt/recipes/nginx/conf.d
-      - ./mediafiles:/opt/recipes/mediafiles
-    depends_on:
-      - db_recipes
-    networks:
-      - default
-
-  nginx_recipes:
-    image: nginx:mainline-alpine
-    restart: always
-    env_file:
-      - ./.env
-    depends_on:
-      - web_recipes
-    volumes:
-      - nginx_config:/etc/nginx/conf.d:ro
-      - staticfiles:/static
-      - ./mediafiles:/media
-    networks:
-      - default
-      - nginx-proxy
-
-networks:
-  default:
-  nginx-proxy:
-    external:
-      name: nginx-proxy
-
-volumes:
-  nginx_config:
-  staticfiles:
-```
 
 ## Additional Information
 

mkdocs.yml

@@ -21,6 +21,9 @@ markdown_extensions:
   - pymdownx.highlight
   - pymdownx.superfences
 
+plugins:
+  - include-markdown
+
 nav:
   - Home: 'index.md'
   - Installation: