fa-material 1.1.0

Font Awesome Pro + Material for MkDocs

fa-material

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.

Font Awesome 5

You can use Font Awesome 5 with fa-material by setting fontawesome-pro's version option to 5.

plugins:
  - fontawesome-pro:
      version: 5

This option must be either 5 or 6, defaulting to the latter.

License

fa-material is licensed under the MIT License.