-
Notifications
You must be signed in to change notification settings - Fork 0
/
readme.txt
50 lines (31 loc) · 2.15 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
=== Dynamic SVG Icons ===
Contributors: philkurth
Tags: SVG, Icons
Requires at least: 5.0
Tested up to: 5.1.1
Requires PHP: 7.0
Stable tag: 1.0
License: GPL2
License URI: https://www.gnu.org/licenses/gpl-2.0.html
Dynamically place SVG icons and images on your site via JavaScript-based replacement of HTML placeholders. Similar to how some icon fonts work but without the extra HTTP requests.
== Description ==
This plugin provides a number of icons out-of-the-box that can be enabled and included in a site as SVG markup. Custom SVG icons/images are also supported.
The icons are placed on a page as HTML elements with specific class names which the plugin then replaces with SVG code via JavaScript.
For a full list of built-in SVG icons see [built-in icons](https://mishterk.github.io/dynamic-svg-icons-plugin-for-wordpress/built-in-icons).
== Installation ==
1. Download `dynamic-svg-icons.zip`
1. Unzip
1. Upload `dynamic-svg-icons` directory to your `/wp-content/plugins` directory
1. Go to the plugin management page and enable the plugin
You can find full details of installing a plugin on the [plugin installation page](https://redirection.me/support/installation/).
Full documentation can be found on the [GitHub repository docs](https://mishterk.github.io/dynamic-svg-icons-plugin-for-wordpress/).
== Frequently Asked Questions ==
= Why would I use this over an icon font? =
This approach cuts out the additional requests to load an icon font. It is also easier to register your custom SVG images with this plugin than to load them into an icon font.
= Can I use my own SVG images? =
Yes. See the [_using custom SVGs section_](https://mishterk.github.io/dynamic-svg-icons-plugin-for-wordpress#using-custom-svgs) of the documentation to learn how.
= Can I override the default icon SVG markup? =
Yes. See the [_overriding built-in SVGs section_](https://mishterk.github.io/dynamic-svg-icons-plugin-for-wordpress#overriding-built-in-svgs) of the documentation to learn how.
== Support ==
Please submit bugs, patches, and feature requests to:
[https://github.com/mishterk/dynamic-svg-icons-plugin-for-wordpress](https://github.com/mishterk/dynamic-svg-icons-plugin-for-wordpress)