forked from starterblocks/starterblocks
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathreadme.txt
217 lines (167 loc) · 16.9 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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
=== Gutenberg Blocks Library – StarterBlocks ===
Contributors: dovyp, starterblocks, redux
Donate link: https://paypal.me/ReduxFramework
Tags: gutenberg, blocks, gutenberg blocks, editor, block, page builder, block editor, block library, editor, templates, library
Requires at least: 5.4
Tested up to: 5.5
Stable tag: 1.0.6
Requires PHP: 5.6
License: GPL-2.0+
License URI: http://www.gnu.org/licenses/gpl-2.0.txt
Supercharge the Gutenberg editor with our ever-growing library of block-based templates!
== Description ==
<strong>StarterBlocks - The Blocks Template Library for Gutenberg</strong>
Supercharge the Gutenberg editor with our ever-growing library of templates. Discovery what's possible and implement any design on your website in virtually no time at all.
Worried that our templates may not work with your theme? We've got you covered. With our custom <em>page templates</em> option you can override any theme. Missing a plugin a template needs? No worries, we’ll even help you install what you need, all from the Gutenberg editor.
Don’t waste hours trying to recreate a template you love. With a click of a button it is own website where you can start customizing it for your needs.
<h4>♥️ What the Plugin does?</h4>
<ul>
<li><strong>Browse 700+</strong> templates from your Gutenberg Editor that you can add to your site immediately.</li>
<li><strong>Preview</strong> each Gutenberg block based template in the customizer preview.</li>
<li><strong>Filter</strong> between the dependencies you want, and find exactly what you're looking for.</li>
<li><strong>See instantly</strong> which Gutenberg templates you have everything for, or may need to install some dependencies.</li>
<li><strong>Automated install</strong> of anything you may need to install any template.</li>
<li><strong>Block Patterns library</strong> support built in.</li>
<li>Make the Reusable Blocks visible in our library modal window. 😉</li>
<li>No frontend, no scripts, no styles – nothing! 🙂</li>
<li>Lightweight, efficient</li>
<li>Developer friendly: clean code, inline documentation</li>
</ul>
<h4>🚀 TYPICAL USE CASE OF THIS PLUGIN</h4>
You are building a **big site** with **lots of pages** and you just want it to look amazing. With StarterBlocks you can begin making pages with a variety of "starter blocks," or templates.
You can browse through the categories, as well as collections of like-styled pages. When you find something you like, StarterBlocks makes sure you have everything you need. If a dependency (or required plugin) is missing, you are notified and can install the missing dependency. Worried that our templates may not work with your theme? No problem! With our custom `page templates` options you can transform any site into exactly what you want it to be no matter what them you are using.
Don’t waste hours trying to recreate a design you love. With a click of a button, you have it on your own site and you can begin customizing your "starter block" for your needs.
<h4>🎉 Supported Page Builders</h4>
Currently StarterBlocks supports only the <a href="https://wordpress.org/plugins/gutenberg/"><strong>Gutenberg / Block Editor of WordPress 5.0+</strong></a>.
<h4>🎨 Supported Themes</h4>
Though StarterBlocks will work with any theme that uses Gutenberg, we have found it to work exceptionally well with the following themes.
<ul>
<li><a href="https://wordpress.org/themes/astra/"><strong>Astra Theme</strong></a> with <strong>Astra Pro</strong> Add-On Plugin – <strong>Custom Layouts</strong> (for Layouts, Headers, Footers, Hooks)</li>
<li><a href="https://wordpress.org/themes/generatepress/"><strong>GeneratePress Theme</strong></a> with <strong>GP Premium</strong> Add-On Plugin – <strong>Elements</strong> (for Layouts, Headers, Hooks)</li>
<li><a href="https://wordpress.org/themes/oceanwp/"><strong>OceanWP Theme</strong></a> with <a href="https://wordpress.org/plugins/ocean-extra/"><strong>Ocean Extra</strong></a> free Add-On Plugin – <strong>My Library</strong> (for Layouts, Hooks etc.)</li>
<li><strong>Kava Pro Theme/ CrocoBlock Service</strong> with JetThemeCore Plugin – <strong>My Library</strong> (for Layouts, Pages, Headers, Footers, Single, Archive)</li>
<li><strong>Genesis Framework</strong> with Genesis Child Themes — via <strong>Blox Lite</strong> and <strong>Blox</strong> (Pro) Plugins – <strong>Global Content Blocks</strong> (for Sections, Hooks)</li>
<li><strong>Page Builder Framework</strong> with <strong>WPBF Premium</strong> Add-On Plugin – <strong>Custom Section</strong> (for Sections, Layouts, Hooks etc.)</li>
<li><strong>Customify</strong> with <strong>Customify Pro</strong> Add-On Plugin – <strong>Hooks</strong> (for Layouts, Sections, Hooks etc.)</li>
<li><strong>Suki</strong> with <strong>Suki Pro</strong> Add-On Plugin – <strong>Custom Blocks</strong> (for Layouts, Sections, Hooks etc.)</li>
<li><strong>Neve</strong> with <strong>Neve Pro</strong> Add-On Plugin – <strong>Custom Layouts</strong> (for Layouts, Sections, Hooks etc.)</li>
<li><strong>Woostify</strong> with <strong>Woostify Pro</strong> Add-On Plugin – <strong>Header Footer Builder</strong> (for Elementor theming areas – Headers/ Footers)</li>
<li><strong>Avada Theme</strong> with Avada Fusion Builder – <strong>Library</strong> (for Templates, Pages, Layouts, Columns, Rows)</li>
<li><strong>Divi Theme</strong> with Divi Builder – <strong>Library</strong> (for Templates etc.)</li>
<li><strong>Extra Theme</strong> with Divi Builder – <strong>Library</strong> (for Templates etc.) – <strong>Category Templates</strong> (for Layouts, Templates etc.)</li>
</ul>
<h4>🚀 SUPPORTED PLUGINS</h4>
StarterBlocks works with all plugins that support Gutenberg, but it has been tested specifically with the following to ensure complete compatibility.
<ul>
<li>see Page Builder Plugins above 🙂</li>
<li>see Gutenberg-specific Plugins below 🙂</li>
<li><a href="https://wordpress.org/plugins/redux-framework/"><strong>Redux Framework</strong></a> Plugin – <strong>Theme and Plugin Options/Fields Framework</strong></li>
<li><a href="https://wordpress.org/plugins/advanced-custom-fields/"><strong>Advanced Custom Fields</strong></a> Plugin – <strong>Custom Fields</strong></li>
</ul>
<h4>📦 Supported Gutenberg-Specific Plugins (Block Editor)</h4>
<ul>
<li><a href="https://wordpress.org/plugins/gutenberg/"><strong>Gutenberg</strong></a> Plugin – <strong>Gutenberg</strong> (Bleeding-Edge development in Gutenberg and Gutenberg Blocks)</li>
<li><a href="https://wordpress.org/plugins/acf-blocks/"><strong>ACF Blocks Suite</strong></a> Plugin – <strong>Blocks</strong> (Fields for Gutenberg Blocks)</li>
<li><a href="https://wordpress.org/plugins/advanced-gutenberg-blocks/"><strong>Advanced Gutenberg Blocks</strong></a> Plugin – <strong>Blocks</strong> (Blocks and Tools for Gutenberg Blocks)</li>
<li><a href="https://wordpress.org/plugins/atomic-blocks/"><strong>Atomic Blocks – Gutenberg Blocks Collection</strong></a> Plugin – <strong>Blocks</strong> (Blocks for Gutenberg Blocks)</li>
<li><a href="https://wordpress.org/plugins/block-options/"><strong>Gutenberg Page Building Toolkit – EditorsKit</strong></a> Plugin – <strong>Blocks</strong> (Templates & Fields for Gutenberg Blocks)</li>
<li><a href="https://wordpress.org/plugins/block-slider/"><strong>WordPress Slider Plugin – Block Slider</strong></a> Plugin – <strong>Blocks</strong> (Blocks for Gutenberg Blocks)</li>
<li><a href="https://wordpress.org/plugins/coblocks/"><strong>Page Builder Gutenberg Blocks – CoBlocks</strong></a> Plugin – <strong>Blocks</strong> (Blocks for Gutenberg Blocks)</li>
<li><a href="https://wordpress.org/plugins/forms-gutenberg/"><strong>WordPress Form Builder Plugin – Gutenberg Forms</strong></a> Plugin – <strong>Blocks</strong> (Blocks & Forms for Gutenberg Blocks)</li>
<li><a href="https://wordpress.org/plugins/getwid/"><strong>Getwid – Gutenberg Blocks</strong></a> Plugin – <strong>Blocks</strong> (Templates & Blocks for Gutenberg Blocks)</li>
<li><a href="https://wordpress.org/plugins/gutentor/"><strong>Gutenberg Blocks – Gutentor Page Builder for Gutenberg Editor</strong></a> Plugin – <strong>Blocks</strong> (Gutenberg Blocks)</li>
<li><a href="https://wordpress.org/plugins/kadence-blocks/"><strong>Kadence Blocks – Gutenberg Page Builder Toolkit</strong></a> Plugin – <strong>Blocks</strong> (Blocks for Gutenberg Blocks)</li>
<li><a href="https://wordpress.org/plugins/kioken-blocks/"><strong>Page Builder Gutenberg Blocks – Kioken Blocks</strong></a> Plugin – <strong>Blocks & Templates</strong> (Blocks for Gutenberg Blocks)</li>
<li><a href="https://wordpress.org/plugins/otter-blocks/"><strong>Gutenberg Blocks and Template Library by Otter</strong></a> Plugin – <strong>Blocks & Templates</strong> (Blocks and Templates for Gutenberg Blocks)</li>
<li><a href="https://wordpress.org/plugins/qubely/"><strong>Gutenberg Blocks and Page Builder – Qubely</strong></a> Plugin – <strong>Blocks & Templates</strong> (Templates & Blocks for Gutenberg Blocks)</li>
<li><a href="https://wordpress.org/plugins/qodeblock/"><strong>Gutenberg Blocks Collection – qodeblock</strong></a> Plugin – <strong>Blocks</strong> (Blocks for Gutenberg Blocks)</li>
<li><a href="https://wordpress.org/plugins/stackable-ultimate-gutenberg-blocks/"><strong>Stackable – Page Builder Gutenberg Blocks</strong></a> Plugin – <strong>Blocks & Templates</strong> (Templates & Blocks for Gutenberg Blocks)</li>
<li><a href="https://wordpress.org/plugins/ultimate-blocks/"><strong>Ultimate Blocks – Gutenberg Blocks Plugin</strong></a> Plugin – <strong>Blocks</strong> (Blocks for Gutenberg Blocks)</li>
<li><a href="https://wordpress.org/plugins/ultimate-addons-for-gutenberg/"><strong>Gutenberg Blocks – Ultimate Addons for Gutenberg</strong></a> Plugin – <strong>Blocks</strong> (Blocks for Gutenberg Blocks)</li>
</ul>
<h4>👍 BE A CONTRIBUTOR</h4>
If you want to translate, <a href="https://translate.wordpress.org/projects/wp-plugins/starterblocks">go to the Translation Portal at translate.wordpress.org</a>.
You can also contribute code-wise via our <a href="https://github.com/starterblocks/starterblocks/">GitHub Repository</a> – and see where you can help. Be sure to use our develop branch to submit pull requests.
<h4>📝 Documentation and Support</h4>
<ul>
<li>For more information about features, FAQs and documentation, check out our website at <a href="https://starterblocks.io/" rel="nofollow ugc">StarterBlocks</a>.</li>
<li>If you have any more questions, visit our support on the <a href="https://wordpress.org/support/plugin/starterblocks">Plugin's Forum</a>.</li>
</ul>
<h4>⚡ Like the StarterBlocks Plugin?</h4>
<ul>
<li>Follow us on <a href="https://www.facebook.com/starterblocks" rel="nofollow ugc">Facebook 💬</a></li>
<li><strong>Rate us 5 ⭐ stars</strong> on <a href="https://wordpress.org/support/plugin/starterblocks/reviews/?filter=5/#new-post">WordPress.org</a></li>
<li><a href="https://updates.starterblocks.io/welcome" rel="nofollow ugc"><strong>Subscribe to my Newsletter for insider info on this plugin</strong> 💯</a></li>
<li><a href="https://github.com/sponsors/dovy/" rel="nofollow ugc"><strong>Become a Sponsor</strong> 💜</a> and support ongoing development, maintenance and support of this plugin</li>
<li>Follow us on Twitter 🐦: <a href="https://twitter.com/starterblocks" rel="nofollow ugc">@StarterBlocks</a> and <a href="https://twitter.com/dovyp" rel="nofollow ugc">@DovyP</a></li>
</ul>
<h4>🔐 Privacy</h4>
StarterBlocks does not interact with end users on your website. Our templates will continue to work even if StarterBlocks is uninstalled.
StarterBlocks utilizes [Freemius](https://freemius.com/) for account management as well as to enable our premium offerings. You can find their privacy policy here: [https://freemius.com/privacy/](https://freemius.com/privacy/) and their terms of service here: [https://freemius.com/terms/](https://freemius.com/terms/).
The StarterBlocks plugin uses a custom API to fetch our content library and our Gutenberg templates. To improve the service and stability we store logs which may or may not contain the following "Non-Personal Information:"
<ul>
<li>browser type</li>
<li>referring site</li>
<li>date and time of request</li>
<li>template ID requested</li>
<li>date of cached version of the given API request</li>
<li>supported block plugins installed (slug only, no versions)</li>
<li>version of StarterBlocks installed</li>
</ul>
API requests are only made when a user clicks on the Library button or click to launch the StarterBlocks tour.
For more details on our privacy policy: [https://starterblocks.io/privacy](https://starterblocks.io/privacy)
For more details on on our terms and conditions: [https://starterblocks.io/terms](https://starterblocks.io/terms)
== Installation ==
1. Upload the entire plugin folder to the `/wp-content/plugins/` directory.
2. Activate the plugin through the 'Plugins' menu in WordPress.
Once Activated, you will find a 'Library' at the top of the Gutenberg editor.
For basic usage, you can also have a look at the plugin website [StarterBlocks](https://starterblocks.io/).
If you want, you can use the [Gutenberg](https://starterblocks.io/) plugin to get bleeding-edge experiments by the Gutenberg team.
== Screenshots ==
1. The StarterBlocks every-growing library of templates.
2. Grouped pages known as collections, helping you build out any website.
3. Preview the template before you import it.
4. Import wizard with integrated dependency installer.
5. Integrated tour.
== Changelog ==
= 1.0.6 =
* Change: Sidebar colors now use default WordPress colors.
* Fixed: Flicker that happened with the import dialog.
* Fixed: Tour launch as well as tour re-running after page reload.
* Fixed: Nearly all translation strings in the JavaScript, have a few sprintf's to complete.
* Fixed: Bug where if import is closed and re-tried, multiple imports of the same template occur.
* Change: Cleaner path to upgrading to StarterBlocks Premium.
= 1.0.5 =
* Fixed: Race condition bug.
= 1.0.4 =
* Feature: Share links now working for both full page and section.
* Feature: Upgrade path is much clearer.
* Fixed: Dependency filter bugs.
* Fixed: Brought navigation in line with Block Editor design patterns. Thanks @mapk.
* Fixed: Removed unneeded language packs and implemented WP i38n for JS. Thanks @garrett-eclipse
= 1.0.3 =
* Feature: Fixed the API to work in different nations by having a standard URL.
* Fixed: Bug where the library got stuck without entries.
= 1.0.2 =
* Feature: Better filtering response.
* Update: Added hiding of extra buttons not needed.
= 1.0.1 =
* Fix: API cache issue.
* Feature: Preview Saved and Block Patterns in library.
= 1.0.0 =
* Initial release - April 2020
== Frequently Asked Questions ==
= Who should use the StarterBlocks Block Library for Gutenberg? =
The StarterBlocks Block Library for Gutenberg is a complete package of unique and creative templates that will help you build beautiful pages and posts on a website. It is of value for everyone and for all who love Gutenberg.
= What are the requirements to use the StarterBlocks Library for Gutenberg? =
You only need to have the latest version of WordPress on your website, to begin with. StarterBlocks is for Gutenberg is basically an addon for the default WordPress block editor. Therefore, the latest WordPress installation along with a theme should be enough, to begin with.
= What themes does StarterBlocks Library for Gutenberg work with? =
StarterBlocks is built to work wonderfully with all themes.
= Can I use StarterBlocks for Gutenberg even while having another Page Builder? =
The basic need or requirement for StarterBlocks for Gutenberg is the latest WordPress version. Should you need help, you can <a href="https://starterblocks.io/support/?utm_source=wp-repo&utm_medium=link&utm_campaign=readme" target="_blank" rel="">get in touch with us.</a>
= Can I use StarterBlocks for Gutenberg on client websites? =
Yes! You can certainly use StarterBlocks on yours as well as your client's websites.
= Will StarterBlocks slow down my website? =
Absolutely not! The StarterBlocks Library for Gutenberg plugin is built with ease and performance in mind. Its module architecture and the clean code keep it lightweight and fast. Therefore, it will not affect your website speed and performance in any way.
= What more do I get with the StarterBlocks Library for Gutenberg? =
When you use the StarterBlocks Library for Gutenberg, you get a huge library of ready-to-use sections and page templates that can be imported and used to build your own. Read an article about the <a href="https://www.ultimategutenberg.com/ready-websites-for-gutenberg/?utm_source=wp-repo&utm_medium=link&utm_campaign=readme" target="_blank" rel="">StarterBlocks Library for Gutenberg</a> to know more.