Skip to content

Commit c79d9d6

Browse files
authored
add far role (#35)
1 parent b0f6ec1 commit c79d9d6

File tree

2 files changed

+3
-2
lines changed

2 files changed

+3
-2
lines changed

docs/badges_buttons.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,8 @@ If the theme you are using does not already include the FontAwesome CSS, it shou
208208
html_css_files = ["https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.3/css/fontawesome.min.css"]
209209
```
210210

211-
Use either `fa` (deprecated in font-awesome v5), `fas` or `fab` for the role name.
211+
Use either `fa` (deprecated in font-awesome v5), `fas`, `fab` or `far` for the role name.
212+
Note that not all regular style icons are free, `far` role only works with free ones.
212213

213214
````{tab-set-code}
214215
```markdown

sphinx_design/icons.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
def setup_icons(app: Sphinx) -> None:
3030
app.add_role("octicon", OcticonRole())
3131
app.add_directive("_all-octicon", AllOcticons)
32-
for style in ["fa", "fas", "fab"]:
32+
for style in ["fa", "fas", "fab", "far"]:
3333
# note: fa is deprecated in v5, fas is the default and fab is the other free option
3434
app.add_role(style, FontawesomeRole(style))
3535
app.add_config_value("sd_fontawesome_latex", False, "env")

0 commit comments

Comments
 (0)