add far role (#35)

executablebooks · Oct 16, 2021 · c79d9d6 · c79d9d6
1 parent b0f6ec1
commit c79d9d6
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/docs/badges_buttons.md b/docs/badges_buttons.md
@@ -208,7 +208,8 @@ If the theme you are using does not already include the FontAwesome CSS, it shou
 html_css_files = ["https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.3/css/fontawesome.min.css"]
 ```
 
-Use either `fa` (deprecated in font-awesome v5), `fas` or `fab` for the role name.
+Use either `fa` (deprecated in font-awesome v5), `fas`, `fab` or `far` for the role name.
+Note that not all regular style icons are free, `far` role only works with free ones.
 
 ````{tab-set-code}
 ```markdown

diff --git a/sphinx_design/icons.py b/sphinx_design/icons.py
@@ -29,7 +29,7 @@
 def setup_icons(app: Sphinx) -> None:
     app.add_role("octicon", OcticonRole())
     app.add_directive("_all-octicon", AllOcticons)
-    for style in ["fa", "fas", "fab"]:
+    for style in ["fa", "fas", "fab", "far"]:
         # note: fa is deprecated in v5, fas is the default and fab is the other free option
         app.add_role(style, FontawesomeRole(style))
     app.add_config_value("sd_fontawesome_latex", False, "env")