forked from rachelbaker/Font-Awesome-WordPress-Plugin
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathreadme.txt
130 lines (69 loc) · 3.34 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
=== Font Awesome Icons ===
Contributors: rachelbaker, BFTrick, Taylor4484, tommarshall, rscarvalho
Tags: icons, font-awesome, font icon, UI, icon font, bootstrap
Requires at least: 3.0
Tested up to: 3.6 beta2
Stable tag: 3.2.1
License: GPLv3 or later
License URI: http://www.gnu.org/licenses/gpl-3.0.html
Enables easy use of the Font Awesome icon font set from within WordPress. Icons can be inserted using either HTML, shortcode, or a built-in TinyMCE plugin.
== Description ==
Font Awesome is a pictographic font set of 361 icons. The icons are infinitely scalable and screen reader compatible.
A full list of the 361 Font Awesome icons is available: [FontAwesomeIconsCheatsheet.pdf](http://f.cl.ly/items/2e1b3q3g081M173m070I/FontAwesomeIconsCheatsheet.pdf)
To use any of the Font Awesome icons on your WordPress site you have three options:
__HTML__
All code examples on the Font Awesome site apply: [http://fontawesome.io/examples/](http://fontawesome.io/examples/)
**Examples**
Pencil icon
`<i class="icon-pencil"></i>`
Phone icon
`<i class="icon-phone"></i>`
Chevron left icon
`<i class="icon-chevron-left"></i>`
__Shortcode__
Don't want to worry about HTML tags? You can use a shortcode in your posts, pages and even widgets to display a Font Awesome icon.
The shortcode to use is `[icon name=name-of-icon]`, where name=X is the class of the icon you would like to use.
**Examples**
Pencil icon
`[icon name=icon-pencil]`
Phone icon
`[icon name=icon-phone]`
Chevron left icon
`[icon name=icon-chevron-left]`
__TinyMCE Plugin__
Select the icon you would like to add to your post or page content from the Glyphs drop-down menu in the Visual Editor.
__Contributors Welcome__
* Submit a [pull request on Github](https://github.com/rachelbaker/Font-Awesome-WordPress-Plugin)
__Author__
* [Rachel Baker](http://rachelbaker.me)
== Installation ==
1. Upload Font Awesome Icons to the `/wp-content/plugins/` directory.
2. Activate the plugin through the 'Plugins' menu in WordPress.
3. Use one of the three usage methods (HTML, Shortcode, or TinyMCE plugin) within the content of your posts or pages.
4. Use either the HTML or Shortcode methods inside your text widgets.
== Screenshots ==
1. HTML code samples
2. Shortcode samples
3. TinyMCE plugin
4. Full icon list
== Changelog ==
= 3.2.1 =
* Updated font and CSS files to Font Awesome 3.2.1 release. (Thanks to @tommarshall)
* Updated build/icons.yml file for reference. (Thanks to @tommarshall)
* Updated reference PDF file with Font Awesome 3.2.1 icons. (Thanks to @tommarshall)
* Added TinyMCE editor plugin, making it possible for the user to select font awesome glyphs from a drop-down list within the content editor. (Thanks @rscarvalho)
* Added version number constant to cache bust assets for future plugin updates. (Thanks @rscarvalho)
= 3.1 =
* Updated font and CSS files to Font Awesome 3.1 release. (Thanks to @Taylor4484)
* Updated reference urls to new Font Awesome URL. (Thanks to @Taylor4484)
* Added build/icons.yml file for reference. (Thanks to @BFTrick)
* Updated reference PDF file with Font Awesome 3.1 icons.
= 3.0 =
* Updated font and CSS files to Font Awesome 3.0 release.
= 1.2 =
* Added IE7 CSS
= 1.1 =
* Created and enabled shortcode
= 1.0 =
* Initial release