| Name | fa-material JSON |
| Version |
1.1.0
JSON |
| download |
| home_page | |
| Summary | Font Awesome Pro + Material for MkDocs |
| upload_time | 2023-04-28 02:35:48 |
| maintainer | |
| docs_url | None |
| author | celsius narhwal |
| requires_python | >=3.7,<4.0 |
| license | MIT |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# fa-material
[](https://pypi.org/project/fa-material)
[](https://pypi.org/project/fa-material)
[](https://github.com/celsiusnarhwal/fa-material/releases)
[](https://github.com/celsiusnarhwal/fa-material/blob/main/LICENSE.md)
[](https://github.com/psf/black)
fa-material is the easiest way to use [Font Awesome](https://fontawesome.com/) [Pro](https://fontawesome.com/plans) icons in
your [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) project.
An active Font Awesome Pro license is required to use fa-material.
## Installation
1. [Install Font Awesome Pro's Python package](https://fontawesome.com/docs/web/use-with/python-django#using-font-awesome-pro-with-django).
2. Install fa-material.
```bash
pip install fa-material
```
## Usage
Add the `fontawesome-pro` plugin to `mkdocs.yml`:
```yaml
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`.
```yaml
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](LICENSE.md).
Raw data
{
"_id": null,
"home_page": "",
"name": "fa-material",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "celsius narhwal",
"author_email": "hello@celsiusnarhwal.dev",
"download_url": "https://files.pythonhosted.org/packages/e2/1f/cdbff0560fd6ccf4c2075d8f34dc95114ab369a5a3a33ad36a69ce5e15ed/fa_material-1.1.0.tar.gz",
"platform": null,
"description": "# fa-material\n\n[](https://pypi.org/project/fa-material)\n[](https://pypi.org/project/fa-material)\n[](https://github.com/celsiusnarhwal/fa-material/releases)\n[](https://github.com/celsiusnarhwal/fa-material/blob/main/LICENSE.md)\n[](https://github.com/psf/black)\n\nfa-material is the easiest way to use [Font Awesome](https://fontawesome.com/) [Pro](https://fontawesome.com/plans) icons in\nyour [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) project.\n\nAn active Font Awesome Pro license is required to use fa-material.\n\n## Installation\n\n1. [Install Font Awesome Pro's Python package](https://fontawesome.com/docs/web/use-with/python-django#using-font-awesome-pro-with-django).\n2. Install fa-material.\n\n ```bash\n pip install fa-material\n ```\n\n## Usage\n\nAdd the `fontawesome-pro` plugin to `mkdocs.yml`:\n\n```yaml\nplugins:\n - fontawesome-pro\n```\n\nThat's it. You can now use Font Awesome Pro icons in the same way you already do Font Awesome Free icons (e.g.\n`:fontawesome-thin-user-secret:`). They'll work in Markdown files, `mkdocs.yml`, and anywhere else Material for MkDocs'\nicon system is used.\n\n### Font Awesome 5\n\nYou can use Font Awesome 5 with fa-material by setting `fontawesome-pro`'s `version` option to `5`.\n\n```yaml\nplugins:\n - fontawesome-pro:\n version: 5\n```\n\nThis option must be either `5` or `6`, defaulting to the latter.\n\n## License\n\nfa-material is licensed under the [MIT License](LICENSE.md).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Font Awesome Pro + Material for MkDocs",
"version": "1.1.0",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e76833cd008f197c7f07858deaafba99b913a8ecb2e1385c247bdbceed8e80d8",
"md5": "c4b95c0359329d94e9bdcacb9c05f683",
"sha256": "c3034843ecb20cee0f7d27e89d9bce9b06fb7907e410a6ec14b99a9564eb3dce"
},
"downloads": -1,
"filename": "fa_material-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c4b95c0359329d94e9bdcacb9c05f683",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7,<4.0",
"size": 3948,
"upload_time": "2023-04-28T02:35:46",
"upload_time_iso_8601": "2023-04-28T02:35:46.492870Z",
"url": "https://files.pythonhosted.org/packages/e7/68/33cd008f197c7f07858deaafba99b913a8ecb2e1385c247bdbceed8e80d8/fa_material-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e21fcdbff0560fd6ccf4c2075d8f34dc95114ab369a5a3a33ad36a69ce5e15ed",
"md5": "37ecb47474b58410686b44dc2020c666",
"sha256": "a610ea1f8c68ee05c29aee901f2beb6de9fcf06aab5e0e4257eb53f878d056d9"
},
"downloads": -1,
"filename": "fa_material-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "37ecb47474b58410686b44dc2020c666",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7,<4.0",
"size": 3153,
"upload_time": "2023-04-28T02:35:48",
"upload_time_iso_8601": "2023-04-28T02:35:48.380882Z",
"url": "https://files.pythonhosted.org/packages/e2/1f/cdbff0560fd6ccf4c2075d8f34dc95114ab369a5a3a33ad36a69ce5e15ed/fa_material-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-28 02:35:48",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "fa-material"
}
