From 1b513083bebbb063fa25acb1cc4abadfd3496429 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ren=C3=A9=20Kilczan?= Date: Tue, 26 Oct 2021 09:35:02 +0200 Subject: [PATCH] Explain how mkdocs plugins are supported (#130) I found no reference how to install the required dependencies. This feature is already there but not documented, so I extended the README file. Out of my view this resolves #12, #53 and #97 Signed-off-by: rekire --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index f8a5b57..45da689 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,10 @@ This action supports deployment of mkdocs with different file path , if you popu Some Python packages require C bindings. These packages can be installed using the `EXTRA_PACKAGES` variable. The `EXTRA_PACKAGES` variable will be passed to the `apk add` command of Alpine Linux before running `pip install` to install the Python packages. +## Installing mkdocs plugins + +If you use some mkdocs plugins like [`codeinclude`](https://github.com/rnorth/mkdocs-codeinclude-plugin) then you need to define it as dependency in the typical python way with a `requirements.txt` file. In the sample above you need to add the line `mkdocs-codeinclude-plugin`. Then you need to link the file using the `REQUIREMENTS` variable. + ## Example usage ```shell @@ -66,4 +70,5 @@ jobs: CONFIG_FILE: folder/mkdocs.yml EXTRA_PACKAGES: build-base # GITHUB_DOMAIN: github.myenterprise.com + REQUIREMENTS: folder/requirements.txt ```