Skip to content

Commit

Permalink
Explain how mkdocs plugins are supported (#130)
Browse files Browse the repository at this point in the history
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 <git@reki.re>
  • Loading branch information
rekire authored Oct 26, 2021
1 parent 58fb72c commit 786c1c8
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -66,4 +70,5 @@ jobs:
CONFIG_FILE: folder/mkdocs.yml
EXTRA_PACKAGES: build-base
# GITHUB_DOMAIN: github.myenterprise.com
REQUIREMENTS: folder/requirements.txt
```

0 comments on commit 786c1c8

Please sign in to comment.