Skip to content

Commit 9c566ef

Browse files
committed
Add documentation for Font Awesome support. (#338 #328 #249)
1 parent fd03fe6 commit 9c566ef

File tree

2 files changed

+25
-0
lines changed

2 files changed

+25
-0
lines changed

documentation/couscous.yml

+3
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,9 @@ menu:
5252
custom-icons:
5353
text: Customize icons
5454
relativeUrl: docs/customize.html
55+
font-awesome:
56+
text: Font Awesome support
57+
relativeUrl: docs/font-awesome.html
5558
runtime-options:
5659
text: Runtime options
5760
relativeUrl: docs/runtime-options.html

documentation/docs/font-awesome.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
currentMenu: font-awesome
3+
-------------------------
4+
5+
## Customize icons
6+
7+
It is possible to use font-awesome icons if you like. You need to include the [Font Awesome CSS](https://www.bootstrapcdn.com/fontawesome/) in your application. That will enable you to use the icon classes to use those icons.
8+
9+
### Example
10+
11+
```javascript
12+
var items = {
13+
firstCommand: {
14+
name: "Paste",
15+
icon: "fa-trash" // Font-awesome trash icon
16+
}
17+
}
18+
```
19+
20+
## Bring your own icons
21+
22+
It is also possible to use your own SVG icons if you like, you can [customize](customize) this by using the SASS files.

0 commit comments

Comments
 (0)