From cb9da8c96750c337be4291531364ea0591e03420 Mon Sep 17 00:00:00 2001 From: Ulf Gebhardt Date: Wed, 12 Mar 2025 08:49:52 +0100 Subject: [PATCH] docs: describe the requirements to get `vuepress-plugin-imagemin` compiling on alpine (#262) For `vuepress-plugin-imagemin` there are several system packages required to properly compile it. It is now documented in the README.md. Switch from `bash` to `sh` highlighting. --- README.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 68cabc8..ad6e861 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,12 @@ This package requires: - [nodejs](https://github.com/nodejs/node) - [npm](https://github.com/npm/cli) +On alpine you need to install the following software to get the `vuepress-plugin-imagemin` properly installed: + +```sh +apk add autoconf libtool automake build-base nasm libpng-dev +``` + ## Techstack This package uses: @@ -25,7 +31,7 @@ How to use this package Build the static files of the website which then can be found under `docs/.vuepress/dist/`. -```bash +```sh npm run build ``` @@ -33,7 +39,7 @@ npm run build Bring up a development environment with hot reloading which can be reached [under](http://localhost:8080/) -```bash +```sh npm run dev ``` @@ -41,7 +47,7 @@ npm run dev Run the tests to ensure everything is working as expected -```bash +```sh npm test ``` @@ -51,7 +57,7 @@ You can use the webhook template `webhook.conf.template` and the `deploy.sh` scr For this to work follow these steps (using alpine): -```bash +```sh apk add webhook cp .github/webhooks/hooks.json.template .github/webhooks/hooks.json vi .github/webhooks/hooks.json