forked from themeum/kirki
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathreadme.txt
87 lines (72 loc) · 5.1 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
=== Kirki Customizer Framework ===
Contributors: davidvongries, aristath, dannycooper, wplemon, igmoweb
Tags: customizer, options framework, theme, mods, toolkit, gutenberg
Requires at least: 5.2
Tested up to: 6.1
Stable tag: 4.1.1
License: MIT
License URI: https://opensource.org/licenses/MIT
The Ultimate Customizer Framework for WordPress Theme Developers
== Description ==
[](https://travis-ci.org/aristath/kirki) [](https://codeclimate.com/github/aristath/kirki) [](https://opensource.org/licenses/MIT) [](https://www.codacy.com/app/aristath/kirki?utm_source=github.com&utm_medium=referral&utm_content=aristath/kirki&utm_campaign=Badge_Grade) [](https://scrutinizer-ci.com/g/aristath/kirki/?branch=develop)
**NEW - [Kirki PRO](https://kirki.org/extensions/?utm_source=repo&utm_medium=description&utm_campaign=kirki) is now available!**
[Kirki](https://kirki.org/?utm_source=repo&utm_medium=description&utm_campaign=kirki) allows theme developers to build themes quicker & more easily.
With over **30 custom controls** ranging from simple sliders to complex typography controls with Google-Fonts integration and features like automatic CSS & `postMessage` script generation, Kirki makes theme development a breeze.
### Features ✅ ###
* Increased Performance
* Simplified API
* Automatic CSS Generation
* Automatic postMessage Generation
* Partial Refresh
* Conditional Logic
* GDPR Compliance
* Improved Page Speed
* & more!
### Controls 🎛️ ###
* [Background Customizer Control](https://kirki.org/docs/controls/background)
* [Code Customizer Control](https://kirki.org/docs/controls/code)
* [Checkbox Customizer Control](https://kirki.org/docs/controls/checkbox)
* [Color Customizer Control](https://kirki.org/docs/controls/color)
* [Color Palette Customizer Control](https://kirki.org/docs/controls/color-palette)
* [Custom Customizer Control](https://kirki.org/docs/controls/custom)
* [Dashicons Customizer Control](https://kirki.org/docs/controls/dashicons)
* [Date Customizer Control](https://kirki.org/docs/controls/date)
* [Dimension Customizer Control](https://kirki.org/docs/controls/dimension)
* [Dimensions Customizer Control](https://kirki.org/docs/controls/dimensions)
* [Dropdown Pages Customizer Control](https://kirki.org/docs/controls/dropdown-pages)
* [Editor Customizer Control](https://kirki.org/docs/controls/editor)
* [Generic Customizer Control](https://kirki.org/docs/controls/generic)
* [Image Customizer Control](https://kirki.org/docs/controls/image)
* [Link Customizer Control](https://kirki.org/docs/controls/link)
* [Multiple Checkbox Customizer Control](https://kirki.org/docs/controls/multicheck)
* [Multicolor Customizer Control](https://kirki.org/docs/controls/multicolor)
* [Number Customizer Control](https://kirki.org/docs/controls/number)
* [Radio Customizer Control](https://kirki.org/docs/controls/radio)
* [Radio Buttonset Customizer Control](https://kirki.org/docs/controls/radio-buttonset)
* [Radio Image Customizer Control](https://kirki.org/docs/controls/radio-image)
* [Repeater Customizer Control](https://kirki.org/docs/controls/repeater)
* [Select Customizer Control](https://kirki.org/docs/controls/select)
* [Slider Customizer Control](https://kirki.org/docs/controls/slider)
* [Sortable Customizer Control](https://kirki.org/docs/controls/sortable)
* [Switch Customizer Control](https://kirki.org/docs/controls/switch)
* [Text Customizer Control](https://kirki.org/docs/controls/text)
* [Textarea Customizer Control](https://kirki.org/docs/controls/textarea)
* [Toggle Customizer Control](https://kirki.org/docs/controls/toggle)
* [Typography Customizer Control](https://kirki.org/docs/controls/typography)
* [Upload Customizer Control](https://kirki.org/docs/controls/upload)
### Kirki PRO Extensions 🏆 ###
Create the WordPress experience your customers deserve with [Kirki PRO Extensions](https://kirki.org/extensions/?utm_source=repo&utm_medium=description&utm_campaign=kirki).
## PRO Features ##
* Tabs
* Responsive Controls
* Input Slider
* Headlines & Dividers
* Margin & Padding Controls
Learn more about [Kirki PRO](https://kirki.org/extensions/?utm_source=repo&utm_medium=description&utm_campaign=kirki).
### Documentation 📖 ###
You can find detailed documentation on how to use Kirki on [kirki.org](https://kirki.org/?utm_source=repo&utm_medium=description&utm_campaign=kirki)
== Installation ==
Simply install as a normal WordPress plugin and activate.
If you want to integrate Kirki in your theme or plugin, please read the instructions on [our documentation site](https://kirki.org/docs/integration).
== Changelog ==
[See the changelogs here](https://github.com/kirki-framework/kirki/blob/master/CHANGELOG.md).