-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
58 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
# Font Awesome extension for Quarto | ||
|
||
This extension allows you to use [Font Awesome](https://fontawesome.com/) icons in your quarto documents. | ||
|
||
## Installation | ||
|
||
From the command line, at the root directory of your quarto project: | ||
|
||
``` | ||
$ quarto install extension https://github.com/quarto-dev/quarto-ext/fontawesome | ||
``` | ||
|
||
This will install the extension under the `_extensions` subdirectory. | ||
If you're using version control, you will want to check in this directory. | ||
|
||
## Usage | ||
|
||
This extension provides the `fa` shortcode: | ||
|
||
``` | ||
{{< fa icon-name >}} | ||
``` | ||
|
||
For example, here's a minimal full document that uses Font Awesome icons in both PDF and HTML: | ||
|
||
--- | ||
format: | ||
pdf: default | ||
html: default | ||
--- | ||
|
||
This is a test. {{< fa book >}} {{< fa download >}} | ||
|
||
## Known Issues | ||
|
||
* The PDF format uses fontawesome5, while the HTML format uses fontawesome6. | ||
* No formatting |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters