Hinode logo
  • About 
  • Docs 
  • Components 
  • Guides 
  • Releases 
  •  
  •    Toggle theme
    •   Light
    •   Dark
    •   Auto
  •  
    •   Light
    •   Dark
    •   Auto
Docs
    • Introduction
    • Commands
    • Hosting and deployment
    • Upgrading
    • Contribute
    • Troubleshooting
    • Content management
    • Content organization
    • Typography
    • Links and cross-references
    • Images and figures
    • Tables
    • Icons
    • Layout
    • Colors
    • Color modes
    • Fonts
    • Languages
    • Navigation
    • Documentation
    • Analytics
    • Modules
    • Abbr
    • Accordion
    • Alert
    • Animation
    • Args
    • Badge
    • Breadcrumb
    • Button
    • Button group
    • Card
    • Card group
    • Carousel
    • Collapse
    • Command prompt
    • Docs
    • Example
    • File
    • Icon
    • Image
    • Kbd
    • Link
    • Map
    • Mark
    • Navbar
    • Navs and tabs
    • Persona
    • Release
    • Spinner
    • Sub
    • Sup
    • Table
    • Timeline
    • Toast
    • Tooltip
    • YouTube
    • Overview
    • Styles
    • Scripts
    • Icons
    • Partial development
    • Module development
    • Server headers
    • Server-side redirection
    • Credits
    • License
    • Introduction
    • Commands
    • Hosting and deployment
    • Upgrading
    • Contribute
    • Troubleshooting
    • Content management
    • Content organization
    • Typography
    • Links and cross-references
    • Images and figures
    • Tables
    • Icons
    • Layout
    • Colors
    • Color modes
    • Fonts
    • Languages
    • Navigation
    • Documentation
    • Analytics
    • Modules
    • Abbr
    • Accordion
    • Alert
    • Animation
    • Args
    • Badge
    • Breadcrumb
    • Button
    • Button group
    • Card
    • Card group
    • Carousel
    • Collapse
    • Command prompt
    • Docs
    • Example
    • File
    • Icon
    • Image
    • Kbd
    • Link
    • Map
    • Mark
    • Navbar
    • Navs and tabs
    • Persona
    • Release
    • Spinner
    • Sub
    • Sup
    • Table
    • Timeline
    • Toast
    • Tooltip
    • YouTube
    • Overview
    • Styles
    • Scripts
    • Icons
    • Partial development
    • Module development
    • Server headers
    • Server-side redirection
    • Credits
    • License

Icon

Share via
Hinode
Link copied to clipboard

Use the icon shortcode to add a Font Awesome icon with ease.

On this page
 

  • Overview
  • Arguments
  • Remarks

Overview  

Added in v0.8.0   

Use the icon shortcode to quickly add a Font Awesome icon to your content. You can also use fa for regular icons, fab for brand icons, and fas for solid icons. As an example, the following shortcodes show a square check, a brand logo, a circle check, and a custom icon.

         
markdown
{{< icon fa square-check >}}
{{< fa square-check >}}
{{< fab linkedin >}}
{{< fas circle-check >}}
{{< icon custom activity >}}

Arguments  

 
When using inline vector icons, be sure to use the main name of the icon. The shortcode does not recognize the aliases of the icons and will throw an error or warning.

The shortcode supports both unnamed arguments and named arguments. When using unnamed arguments, all attributes are mapped to the class argument, separated by spaces.

Argument Required Description
class Yes Family, name, and styling of the icon to display. The shortcode expects the following format and order: {family} {name} {style attributes}. The shortcode supports the default families of the free version of Font Awesome, including shorthand notation: “fa-solid” (“fas”), “fa-regular” (“fa”), “fa-brands” (“fab”). You can omit the fa- prefix of the icon name. Alternatively, you can reference a custom family and icon stored in assets/svgs/{family}/{icon}.svg.
style No Optional custom style of the icon, e.g. --fa-animation-duration: 2s;. Hinode disables inline styles by default, review the Content Security Policy for more details.
spacing No
v0.21.0   
  Optional flag to add a trailing whitespace character to optimize inline rendering, defaults to “true”.
Name Type Required Default Comment
class string Family, name, and styling of the icon to display. The shortcode expects the following format and order: {family} {name} {style attributes}. The shortcode supports the default families of the free version of Font Awesome, including shorthand notation: fa-solid (fas), fa-regular (fa), fa-brands (fab). You can omit the fa- prefix of the icon name. When using fhe shortcodes fa.html, fab.html, and fas.html, you can omit the family name. Alternatively, you can reference a custom family and icon stored in assets/svgs/{family}/{icon}.svg.
spacing bool true
v0.21.0   
  Flag to add a trailing whitespace character to optimize inline rendering.
src string
v0.22.0   
  Path to a scalable vector graphics (.svg) file to use instead of a Font Awesome icon. The file is dynamically loaded and supports styling options similar to a regular Font Awesome icon.
style string Custom style of the icon, e.g. --fa-animation-duration: 2s;. Please note that Hinode disables inline styles by default, review the Content Security Policy for more details.
wrapper string
v0.19.0   
  Class attributes of the wrapper element. The wrapper adds the fa-wrapper and fa-fluid attributes by default.

Remarks  

See the icons documentation in the content section for additional styling options.

Last updated: January 2, 2024 • Move arguments to data structure (5dbf1b8)
On this page
  • Overview
  • Arguments
  • Remarks
Icon
Icon
Hinode is a clean documentation and blog theme for your Hugo site based on Bootstrap 5.
Code licensed MIT, docs CC BY-NC 4.0
Currently v0.23.0-beta4
 
Links
Home 
About 
Docs 
Components 
Releases 
Guides
Getting started 
Developing modules 
Optimization 
Versioning 
Community
Issues   
Discussions   
Contribute 
Hinode
Code copied to clipboard