Skip to content

Latest commit

 

History

History
123 lines (77 loc) · 3.6 KB

CHANGELOG.md

File metadata and controls

123 lines (77 loc) · 3.6 KB
Raw

Changelog1

Notable changes to Iconoclast will be documented here. Breaking changes are marked with a 🚩.

Iconoclast adheres to semantic versioning.

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.
plugins:
  - iconoclast:
      auto: true

3.1.0 — 2024-11-22

Added

  • Iconoclast's new uv option, if set to true, will tell Iconoclast to prefer uv's pip interface over pip. If uv can't be found in your system path, Iconoclast will fall back to pip.
# mkdocs.yml

plugins:
  - iconoclast:
      uv: true

3.0.1 — 2024-11-22

Fixed

  • A minor spelling error.

3.0.0 — 2024-11-10

Changed

  • 🚩 Iconoclast now requires Python 3.8 or later.
  • 🚩 iconoclast install, which previous installed specified Font Awesome Kit, now installs Font Awesome Pro.
  • 🚩 iconoclast kit is the new command for installing a Font Awesome Kit.
  • 🚩 The iconoclast setup command has been removed and replaced by iconoclast install.

2.1.0 — 2023-06-04

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)

<a name="2-0-3>2.0.3 — 2023-05-16

Fixed

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

2.0.2 — 2023-05-16

Changed

  • The iconocards plugin now emits a deprecation warning on versions of Material for MkDocs where it is obsolete.
  • Iconoclast's warning and error messages are now visually consistent with those emitted by MkDocs.

[2.0.1] - 2023-05-11

Fixed

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

2.0.0 — 2023-05-05

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

pip uninstall fa-material && pip install iconoclast

Added

  • Iconoclast now has CSS support, enabling you use Font Awesome icons in block and partial overrides. (Docs)
  • Iconoclast now supports Font Awesome Kits, allowing you to seamlessly bring your own custom icons to Material for MkDocs. (Docs)

Changed

  • 🚩 Iconoclast's plugin is now named iconoclast.
  • 🚩 Support for Font Awesome 5 has been removed. Iconclast supports Font Awesome 6 only.
    • 🚩 The version configuration option has also been removed.

1.1.0 — 2023-04-27

Added

  • fa-material now supports Font Awesome 5 (it previously only supported Font Awesome 6). To use Font Awesome 5, set the version option of the fontawesome-pro plugin to 5 (the default is 6).

    plugins:
  - fontawesome-pro:
      version: 5

1.0.1 — 2023-04-27

Changed

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

1.0.0 — 2023-04-27

This is the initial release of fa-material.

Footnotes

  1. Based on Keep a Changelog ↩