{"id":13780267,"url":"https://quarto-ext.github.io/fontawesome/","last_synced_at":"2025-05-11T13:31:42.576Z","repository":{"id":43955842,"uuid":"509547696","full_name":"quarto-ext/fontawesome","owner":"quarto-ext","description":"Use Font Awesome icons in HTML and PDF documents.","archived":false,"fork":false,"pushed_at":"2024-04-21T20:40:29.000Z","size":1602,"stargazers_count":92,"open_issues_count":9,"forks_count":11,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-05-19T21:01:20.356Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Lua","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/quarto-ext.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-07-01T18:05:22.000Z","updated_at":"2024-05-14T19:17:53.000Z","dependencies_parsed_at":"2023-01-21T19:45:46.079Z","dependency_job_id":"d41bc2ce-dcff-480f-ad23-b457e10fba7b","html_url":"https://github.com/quarto-ext/fontawesome","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quarto-ext%2Ffontawesome","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quarto-ext%2Ffontawesome/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quarto-ext%2Ffontawesome/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quarto-ext%2Ffontawesome/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/quarto-ext","download_url":"https://codeload.github.com/quarto-ext/fontawesome/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224713623,"owners_count":17357247,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-03T18:01:13.954Z","updated_at":"2024-11-17T15:31:01.461Z","avatar_url":"https://github.com/quarto-ext.png","language":"Lua","funding_links":[],"categories":["Example"],"sub_categories":["Accessibility[^1]"],"readme":"# Font Awesome Extension for Quarto\n\nThis extension provides support including free icons provided by [Font Awesome](https://fontawesome.com). Icons can be used in both HTML (via [Font Awesome 6 Free](https://fontawesome.com/search?m=free)) and PDF (via the [fontawesome5 LaTeX package](https://ctan.org/pkg/fontawesome5?lang=en)).\n\n## Installing\n\n```sh\nquarto add quarto-ext/fontawesome\n```\n\nThis will install the extension under the `_extensions` subdirectory.\nIf you're using version control, you will want to check in this directory.\n\nDo note that this extension requires quarto 1.2.198 or higher. We strongly recommend you ensure you're running a recent version of quarto, and download/install one [from the download page](https://quarto.org/docs/download/) if needed.\n\n## Using\n\nTo embed an icon, use the `{{\u003c fa \u003e}}` shortcode. For example:\n\n```default\n{{\u003c fa thumbs-up \u003e}} \n{{\u003c fa folder \u003e}}\n{{\u003c fa chess-pawn \u003e}}\n{{\u003c fa brands bluetooth \u003e}}\n{{\u003c fa brands twitter size=2xl \u003e}}\n{{\u003c fa brands github size=5x \u003e}}\n{{\u003c fa battery-half size=Huge \u003e}}\n{{\u003c fa envelope title=\"An envelope\" \u003e}}\n```\n\nThis extension includes support for only free Font Awesome icons (there are roughly 2,000 free icons, while the complete set of Pro icons consists of more than 16,000).\nYou can browse all of the available free icons here:\n\n\u003chttps://fontawesome.com/search?m=free\u003e\n\n### Brands[^1]\n\nNote that there is a `brands` prefix used within the `bluetooth` example above.\nIf you choose an icon from the `brands` collection, you will need to add a `brands` collection specifier when using any HTML format.\nFor example, if you search the free icons for \"github\" and then click on the `github` icon, you'll see this as the suggested HTML to embed the icon:\n\n```html\n\u003ci class=\"fa-brands fa-github\"\u003e\u003c/i\u003e\n```\n\nThe `fa-brands` indicates that the icon is in the `brands` collection. To use this with Quarto just add the `brands` collection prefix as follows:\n\n```default\n{{\u003c fa brands github \u003e}}\n```\n\n### Sizing Icons\n\nFont Awesome provides relative and literal sizing for icons as described in \u003chttps://fontawesome.com/docs/web/style/size\u003e.  \nWhen the size is invalid, no size changes are made.\n\n- Relative sizing[^1]: `{{\u003c fa battery-half size=2xl \u003e}}`.\n\n  | Relative Sizing Class | Font Size | Equivalent in Pixels |\n  |-----------------------|-----------|----------------------|\n  | fa-2xs                | 0.625em   | 10px                 |\n  | fa-xs                 | 0.75em    | 12px                 |\n  | fa-sm                 | 0.875em   | 14px                 |\n  | fa-lg                 | 1.25em    | 20px                 |\n  | fa-xl                 | 1.5em     | 24px                 |\n  | fa-2xl                | 2em       | 32px                 |\n\n- Literal sizing[^1]: `{{\u003c fa battery-half size=5x \u003e}}`.\n\n  | Literal Sizing Class | Font Size |\n  |----------------------|-----------|\n  | fa-1x                | 1em       |\n  | fa-2x                | 2em       |\n  | fa-3x                | 3em       |\n  | fa-4x                | 4em       |\n  | fa-5x                | 5em       |\n  | fa-6x                | 6em       |\n  | fa-7x                | 7em       |\n  | fa-8x                | 8em       |\n  | fa-9x                | 9em       |\n  | fa-10x               | 10em      |\n\n- LaTeX sizing: `{{\u003c fa battery-half size=Huge \u003e}}`.\n\n  | Sizing Command                   | Font Size (LaTeX)    | Font Size (HTML) |\n  | -------------------------------- | -------------------- | ---------------- |\n  | tiny (= `\\tiny`)                 | 5pt                  | 0.5em            |\n  | scriptsize (= `\\scriptsize`)     | 7pt                  | 0.7em            |\n  | footnotesize (= `\\footnotesize`) | 8pt                  | 0.8em            |\n  | small (= `\\small`)               | 9pt                  | 0.9em            |\n  | normalsize (= `\\normalsize`)     | 10pt (document size) | 1em              |\n  | large (= `\\large`)               | 12pt                 | 1.25em           |\n  | Large (= `\\Large`)               | 14.4pt               | 1.5em            |\n  | LARGE (= `\\LARGE`)               | 17.28pt              | 1.75em           |\n  | huge (= `\\huge`)                 | 20.74pt              | 2em              |\n  | Huge (= `\\Huge`)                 | 24.88pt              | 2.5em            |\n\n### Accessibility[^1]\n\nIf the icon is being used in place of some text,\njust add some descriptive text in the title argument:\n\n```default\n{{\u003c fa envelope title=\"An envelope\" \u003e}}\n```\n\nThis will produce the following HTML:\n\n```html\n\u003ci class=\"fa-solid fa-envelope\" title=\"An envelope\" aria-hidden=\"true\"\u003e\u003c/i\u003e\n```\n\nMore details on Font Awesome accessibility at \u003chttps://fontawesome.com/docs/web/dig-deeper/accessibility\u003e.\n\n[^1]: HTML formats only.\n\n## Example\n\nHere is the source code for a minimal example: [example.qmd](example.qmd).\n\nThis is the output of `example.qmd` for [HTML](https://quarto-ext.github.io/fontawesome/) and [PDF](https://quarto-ext.github.io/fontawesome/example.pdf).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/quarto-ext.github.io%2Ffontawesome%2F","html_url":"https://awesome.ecosyste.ms/projects/quarto-ext.github.io%2Ffontawesome%2F","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/quarto-ext.github.io%2Ffontawesome%2F/lists"}