Skip to content

Commit

Permalink
Update CHANGELOG.md
Browse files Browse the repository at this point in the history
  • Loading branch information
celsiusnarhwal committed Nov 27, 2024
1 parent 04504ea commit d341566
Showing 1 changed file with 23 additions and 10 deletions.
33 changes: 23 additions & 10 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,20 @@ Notable changes to Iconoclast will be documented here. Breaking changes are mark

Iconoclast adheres to [semantic versioning](https://semver.org/spec/v2.0.0.html).

## <a name="3.1.0">[3.1.0] - 2024-11-22</a>
## <a name="3-2-0">3.2.0 — 2024-11-27

### Added

- Iconoclast's new `auto` option, if set to `true`, will have Iconoclast automatically install Font Awesome Pro
whenever your MkDocs site is built.

```yaml
plugins:
- iconoclast:
auto: true
```
## <a name="3-1-0">3.1.0 — 2024-11-22</a>
### Added
Expand All @@ -20,13 +33,13 @@ plugins:
uv: true
```

## <a name="3.0.1">[3.0.1] - 2024-11-22</a>
## <a name="3-0-1">3.0.1 2024-11-22</a>

### Fixed

- A minor spelling error.

## <a name="3.0.0">[3.0.0] - 2024-11-10</a>
## <a name="3-0-0">3.0.0 2024-11-10</a>

### Changed

Expand All @@ -35,22 +48,22 @@ plugins:
- 🚩 `iconoclast kit` is the new command for installing a Font Awesome Kit.
- 🚩 The `iconoclast setup` command has been removed and replaced by `iconoclast install`.

## <a name="2-1-0">[2.1.0] - 2023-06-04</a>
## <a name="2-1-0">2.1.0 2023-06-04</a>

### Added

- Font Awesome Pro can now be installed via the new `iconoclast setup` command. This command supersedes the old,
package manager-dependent, ways of installing Font Awesome Pro, which still work, but are no longer documented or
supported. ([Docs](https://iconoclast.celsiusnarhwal.dev/#installation-and-setup))

## <a name="2-0-3">[2.0.3] - 2023-05-16</a>
## <a name="2-0-3>2.0.3 2023-05-16</a>

### Fixed

- Fixed a bug where Iconoclast might fail when determining whether `iconocards` is deprecated for the installed version
of Material for MkDocs.

## <a name="2-0-2">[2.0.2] - 2023-05-16</a>
## <a name="2-0-2">2.0.2 2023-05-16</a>

### Changed

Expand All @@ -63,7 +76,7 @@ plugins:

- Fixed a bug where Iconoclast's command-line interface would fail.

## <a name="2-0-0">[2.0.0] - 2023-05-05</a>
## <a name="2-0-0">2.0.0 2023-05-05</a>

🚩 fa-material is now **Iconoclast**. To upgrade, uninstall fa-material and install Iconoclast:

Expand All @@ -84,7 +97,7 @@ pip uninstall fa-material && pip install iconoclast
- 🚩 Support for Font Awesome 5 has been removed. Iconclast supports Font Awesome 6 only.
- 🚩 The `version` configuration option has also been removed.

## <a name="1-1-0">[1.1.0] - 2023-04-27</a>
## <a name="1-1-0">1.1.0 2023-04-27</a>

### Added

Expand All @@ -97,13 +110,13 @@ pip uninstall fa-material && pip install iconoclast
version: 5
```

## <a name="1-0-1">[1.0.1] - 2023-04-27</a>
## <a name="1-0-1">1.0.1 2023-04-27</a>

### Changed

- fa-material's Python version constraint has been relaxed to 3.7+.

## <a name="1-0-0">[1.0.0] - 2023-04-27</a>
## <a name="1-0-0">1.0.0 2023-04-27</a>

This is the initial release of fa-material.

Expand Down

0 comments on commit d341566

Please sign in to comment.