Skip to main content

Font Awesome Pro + Material for MkDocs

Project description

fa-material

PyPI - Python Version PyPI GitHub release (latest SemVer) PyPI - License Code style: Black

fa-material is the easiest way to use Font Awesome Pro icons in your Material for MkDocs project.

An active Font Awesome Pro license is required to use fa-material.

Installation

  1. Install Font Awesome Pro's Python package.

  2. Install fa-material.

    pip install fa-material
    

Usage

Add the fontawesome-pro plugin to mkdocs.yml:

plugins:
  - fontawesome-pro

That's it. You can now use Font Awesome Pro icons in the same way you already do Font Awesome Free icons (e.g. :fontawesome-thin-user-secret:). They'll work in Markdown files, mkdocs.yml, and anywhere else Material for MkDocs' icon system is used.

License

fa-material is licensed under the MIT License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fa_material-1.0.1.tar.gz (2.8 kB view details)

Uploaded Source

Built Distribution

fa_material-1.0.1-py3-none-any.whl (3.6 kB view details)

Uploaded Python 3

File details

Details for the file fa_material-1.0.1.tar.gz.

File metadata

  • Download URL: fa_material-1.0.1.tar.gz
  • Upload date:
  • Size: 2.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.1 CPython/3.11.1 Linux/5.15.0-1036-azure

File hashes

Hashes for fa_material-1.0.1.tar.gz
Algorithm Hash digest
SHA256 c6b6b580f0c2d88e6d074bfba5668880b9a1d00a826ff30cd27353fb65b12ff3
MD5 b94f52e91a191556d8ca639a1d15487d
BLAKE2b-256 3776a97ce51d086407af95cc5b3eae6d56c55bfd04d45998e86e68ae99bd19f4

See more details on using hashes here.

File details

Details for the file fa_material-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: fa_material-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 3.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.1 CPython/3.11.1 Linux/5.15.0-1036-azure

File hashes

Hashes for fa_material-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 394ff176da246a68a6cf72d1cc1624b017ca27100ead0301b3e3e1316255ecd2
MD5 15221e3dd15360cf38d6174d8f320814
BLAKE2b-256 27aa6c879c1b1fe0d18721c309f367ec24f77d579b1daf7ea3aad790c0ab1405

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page