williln/wagtail-heroicons

Add Heroicons to the Wagtail admin.

wagtail-heroicons

Add Heroicons to the Wagtail admin.

Requirements

• Python 3.8, 3.9, 3.10, 3.11, 3.12
• Django 3.2, 4.2, 5.0
• Wagtail 5.2, 6.0

Getting Started

1. Install the package from PyPI:

python -m pip install wagtail-heroicons

2. Add the app to your Django project's INSTALLED_APPS:

INSTALLED_APPS = [
    ...,
    "wagtail_heroicons",
    ...,
]

Usage

All icons follow the following naming convention: heroicons-<name>-<style>.

For example, the solid Adjustments icon would be heroicons-adjustments-solid.

To see all available icons, names and styles, visit the Heroicons website.

See the Wagtail documentation for more information on using icons in Wagtail.

License

wagtail-heroicons is licensed under the MIT license. See the LICENSE file for more information.

Heroicons are licensed under the MIT License and are Copyright (c) 2020 Refactoring UI Inc.

MkDocs

To preview the MkDocs docs, run:

mkdocs serve

Then navigate to http://localhost:8000/. There may be formatting issues, because the docs were originally written with the Read the Docs formatting in mind.