Commit 5c5f4d71 authored by Aurelien's avatar Aurelien
Browse files

templates(mkdocs): update template images versions + add additional plugin

parent 13295e83

jobs/mkdocs/CHANGELOG.md

+4 −0
Original line number Diff line number Diff line 
# Changelog

All notable changes to this job will be documented in this file.



## [1.8.0] - 2023-12-22

* Update `material for mkdocs` image version to 9.5.2

* Add `mkdocs-same-dir` in `MKDOCS_ADDITIONAL_PLUGINS` variable to allow placing mkdocs.yml in the same directory as documentation



## [1.7.1] - 2023-02-28

* Fix broken documentation links

jobs/mkdocs/README.md

+5 −5
Original line number Diff line number Diff line
@@ -25,13 +25,13 @@ Mkdocs](https://squidfunk.github.io/mkdocs-material/){:target="_blank"} are read 
| Name | Description | Default |

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

| `MKDOCS_OUTPUT_PATH` | Output directory path | `website_build/` |

| `MKDOCS_ADDITIONAL_PLUGINS` | Value of several [plugins](https://github.com/mkdocs/mkdocs/wiki/MkDocs-Plugins) to install before the build. They have to be separated by `;` | `mkdocs-awesome-pages-plugin;mkdocs-git-revision-date-localized-plugin;mkdocs-macros-plugin` |

| `IMAGE_TAG` | The default tag for the docker image | `8.5.10`  |

| `MKDOCS_ADDITIONAL_PLUGINS` | Value of several [plugins](https://github.com/mkdocs/mkdocs/wiki/MkDocs-Plugins) to install before the build. They have to be separated by `;` | `mkdocs-awesome-pages-plugin;mkdocs-git-revision-date-localized-plugin;mkdocs-macros-plugin;mkdocs-same-dir` |

| `IMAGE_TAG` | The default tag for the docker image | `9.5.2`  |



!!! info

    By default `MKDOCS_ADDITIONAL_PLUGINS` variable contains 3 plugins for `Material for mkdocs`

    If you don't override this variable, it will install those 3 plugins `mkdocs-awesome-pages-plugin`,

    `mkdocs-git-revision-date-localized-plugin`, `mkdocs-macros-plugin`

    By default `MKDOCS_ADDITIONAL_PLUGINS` variable contains plugins for `Material for mkdocs`

    If you don't override this variable, it will install those  plugins `mkdocs-awesome-pages-plugin`,

    `mkdocs-git-revision-date-localized-plugin`, `mkdocs-macros-plugin`, `mkdocs-same-dir`



## Artifacts

jobs/mkdocs/mkdocs.yml

+2 −2
Original line number Diff line number Diff line
@@ -10,9 +10,9 @@ mkdocs: 
  stage: build

  variables:

    MKDOCS_OUTPUT_PATH: 'website_build/'

    MKDOCS_ADDITIONAL_PLUGINS: 'mkdocs-awesome-pages-plugin;mkdocs-git-revision-date-localized-plugin;mkdocs-macros-plugin'

    MKDOCS_ADDITIONAL_PLUGINS: 'mkdocs-awesome-pages-plugin;mkdocs-git-revision-date-localized-plugin;mkdocs-macros-plugin;mkdocs-same-dir'



    IMAGE_TAG: "8.5.10"

    IMAGE_TAG: "9.5.2"

  script:

    - |

      if [[ ${MKDOCS_ADDITIONAL_PLUGINS} != "" ]]; then