FontAwesome 6 LaTeX Package & Builder

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Features
   • Built With
2. Prerequisites
3. Usage
   • Use the built package
   • Make Latest fontawesome6 package
4. Contributing
5. License
6. Contact
7. Acknowledgments

About The Project

This project is a build script for generating a LaTeX package for FontAwesome 6 icons. FontAwesome is a popular icon set and toolkit, and this script facilitates its integration into LaTeX documents by creating a custom .sty file.

(back to top)

Features

• Automated Build Process: The script downloads and processes FontAwesome 6 icons metadata to generate a LaTeX package.
• Customizable Output: The resulting package includes a .sty file with all necessary icon definitions, ready to be included in LaTeX documents.
• Easy Integration: The package can be easily integrated into LaTeX projects, allowing the use of FontAwesome 6 icons in your documents.

(back to top)

Built With

Prerequisites

• You must have the FontAwesome font on your machine (download from here).
• You must be using XeLaTeX or LuaLaTeX and have the fontspec package installed.
• You can use this package with the free and the pro fonts.
• For using the pro features, you need to buy Font Awesome Pro.

(back to top)

Usage

Use the built package

1. Download the fontawesome.zip file from releases if you don't have and put it in the same directory as the LaTeX file using the icons.
2. Extact it into the fontawesome folder.
3. Include the package as normal (in the preamble of the .tex file, add the line \usepackage{fontawesome/fontawesome6}).
4. Use an icon by typing \faIcon{address-book}. Other icons than address-book can be found on the fontawesome website.

(back to top)

Example

Free version

\usepackage{fontawesome/fontawesome6}

\faIcon{font-awesome}
Normal: \faIcon{address-book}
Bold: \textbf{\faIcon{address-book}}

$ xelatex example-free.tex

Pro version

\usepackage[pro]{fontawesome/fontawesome6}

\faIcon{font-awesome}
Normal: \faIcon{alarm-clock}
Bold: \textbf{\faIcon{alarm-clock}}
Italic: \textit{\faIcon{alarm-clock}}

$ xelatex example-pro.tex

Make Latest fontawesome6 package

Requirements

• You need python to create fontawesome6.sty from scratch.
• Download FontAwesome from here and exctact the zip file into fontawesome folder

Usage

$ python build.py

This should result in the creation of latest fontawesome6.sty

---

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Naveen Dharmathunga - @XerDuke - [email protected]

Project Link: https://github.com/D-Naveenz/fontawsome6-latex

(back to top)

Acknowledgments

• Latex Team
• Python
• Img Shields
• Font Awesome

(back to top)