From d2073852396a52c6dbf8f74c79fa527f3b8180fb Mon Sep 17 00:00:00 2001 From: AleksandrHovhannisyan Date: Sat, 23 Sep 2023 14:22:27 -0500 Subject: [PATCH] Update docs to mention workaround for arm64 installation issue (#4, https://github.com/wilsonzlin/minify-html/issues/119) --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4d35f1d..3e0e425 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,8 @@ This plugin adds a paired shortcode to your 11ty site that converts HTML, CSS, a ## Table of Contents - [Getting Started](#getting-started) + - [Installation](#installation) + - [Registering the plugin](#registering-the-plugin) - [Plugin Options](#plugin-options) - [Shortcode Arguments](#shortcode-arguments) - [Example Usage](#example-usage) @@ -21,12 +23,18 @@ This plugin adds a paired shortcode to your 11ty site that converts HTML, CSS, a ## Getting Started -Install the package: +### Installation + +> **Note**: If you are on a [macOS ARM64 device](https://github.com/wilsonzlin/minify-html/issues/119#issuecomment-1688113448), you may run into problems with installing the plugin due to a package dependency. See the linked issue for a known workaround. + +Install the package using your preferred package manager. Example command in yarn: ``` yarn add -D eleventy-plugin-code-demo ``` +### Registering the plugin + Register it as a plugin in your Eleventy config: ```js