📝 Add icons reference to docs

This commit is contained in:
James Panther
2021-12-21 09:11:00 +11:00
parent 6066f87122
commit 101c01b542
3 changed files with 66 additions and 2 deletions
+5 -1
View File
@@ -72,7 +72,11 @@ Similar to the [icon shortcode]({{< ref "shortcodes#icon" >}}), you can include
{{ partial "icon.html" "github" }}
```
Congo includes a number of built-in icons for social, links and other purposes. You can also provide your own icon assets by including the SVG in `assets/icons/`.
Icons are populated using Hugo pipelines which makes them very flexible. Congo includes a number of built-in icons for social, links and other purposes. Check the [icon samples]({{< ref "samples/icons" >}}) page for a full list of supported icons.
Custom icons can be added by providing your own icon assets in the `assets/icons/` directory of your project. The icon can then be referenced in the partial by using the SVG filename without the `.svg` extension.
Icons can also be used in article content by calling the [icon shortcode]({{< ref "shortcodes#icon" >}}).
## Extensions