Skip to content

Commit

Permalink
Update docs to mention workaround for arm64 installation issue (#4, w…
Browse files Browse the repository at this point in the history
  • Loading branch information
AleksandrHovhannisyan committed Sep 23, 2023
1 parent 5de81ec commit d207385
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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
Expand Down

0 comments on commit d207385

Please sign in to comment.