Commit ccd3bdad authored by Pierre Smeyers's avatar Pierre Smeyers
Browse files

docs: normalise table headers

parent bb5dc357

README.md

+3 −3
Original line number Diff line number Diff line
@@ -17,7 +17,7 @@ include: 


The MkDocs template uses some global configuration used throughout all jobs.



| Name                    | description                            | default value     |

| Name                    | Description                            | Default value     |

| ----------------------- | -------------------------------------- | ----------------- |

| `MKD_IMAGE`             | The Docker image used to run MkDocs    | `registry.hub.docker.com/polinux/mkdocs:latest` |

| `MKD_WORKSPACE_DIR`     | MkDocs sources directory | `.` |
@@ -34,7 +34,7 @@ The MkDocs template uses some global configuration used throughout all jobs. 


This job performs MkDocs **build**. It uses the following variable:



| Name                    | description                                       | default value     |

| Name                    | Description                                       | Default value     |

| ----------------------- | ------------------------------------------------- | ----------------- |

| `MKD_BUILD_ARGS`        | Arguments used by the build job                   | _none_ |
@@ -45,7 +45,7 @@ Be sure to update `MKD_SITE_DIR` if you change the output directory (via the `MK 


This job checks links with [lychee](https://github.com/lycheeverse/lychee). It uses the following variable:



| Name                    | description                                       | default value     |

| Name                    | Description                                       | Default value     |

| ----------------------- | ------------------------------------------------- | ----------------- |

| `MKD_LYCHEE_ENABLED`    | Set to `true` to enable this job                  | _none_ (disabled) |

| `MKD_LYCHEE_IMAGE`      | The Docker image used to run [lychee](https://github.com/lycheeverse/lychee) | `registry.hub.docker.com/lycheeverse/lychee:latest` |