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.0.tar.gz (2.8 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: fa_material-1.0.0.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.0.tar.gz
Algorithm Hash digest
SHA256 7c4866516e2dbf381f219ce0b52a1360645e26e53f1e2f85b392fd4912f5684d
MD5 549941da59f70ebc64d3947fe6430b63
BLAKE2b-256 93563c95cce97c026650c3afa64c1328683c8685782ae5df3b62a436a805e25f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: fa_material-1.0.0-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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 75264922212a1f118a73da38e9612e5debb823ec38efe77fb2967ef22646935e
MD5 fb047a5fdab8b82de47ca803cb9c9523
BLAKE2b-256 f908cb5d2a233d8026a14873a36d4af97d17251f2fb4583798668dbc0af573a6

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