-
Notifications
You must be signed in to change notification settings - Fork 3
/
readme.txt
248 lines (196 loc) · 11.8 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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
=== Modul R ===
Contributors: codekraft
Requires at least: 4.9.6
Tested up to: 5.8
Requires PHP: 5.6
Stable tag: 2.0.0
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
Donate link: https://www.paypal.com/pools/c/8g9fVFSHkc
Tags: blog, e-commerce, portfolio, one-column, grid-layout, custom-background, custom-header, custom-logo, custom-menu, editor-style, featured-images, full-width-template, block-styles, wide-blocks, sticky-post, threaded-comments, translation-ready
Elevate your web presence with Modul R, a dynamic and highly flexible WordPress theme engineered for the modern era that comes with batteries included. The v2 theme represents a significant upgrade, packed with an array of improvements designed to transform your web design experience. Modul R isn't just a theme; it's your go-to toolkit for crafting extraordinary websites with an emphasis on speed and performance.
== Description ==
Modul R is a powerful and flexible theme that provides a fast way to create an awesome website. Modul R brings plenty of customization possibilities thanks to gulp4, it comes with preconfigured SASS style, visibility triggered animations, image parallax, lightbox, slider, grid layout (masonry), category sidebar accordion and many more features!
Modul R also provides a seamless integration with Gutenberg and Woocommerce.
[Demo](https://modul-r.codekraft.it)
Key Features:
- 💡 Modular Design: Modul R is your gateway to a world of creative possibilities. It serves as a versatile starter theme, offering an arsenal of reusable components and functions. Whether you're a seasoned developer or a novice, you can easily leverage these tools to create a web masterpiece.
- ⚡ Performance Optimization: In an age where website speed is paramount, Modul R takes the lead. The theme has been meticulously optimized to ensure lightning-fast loading times, providing a seamless user experience for your visitors.
- 🎨 Stylish SASS Customization: With Modul R, the style is at your command. Harness the power of SASS to tailor your website's appearance. A plethora of customization options is at your fingertips, allowing you to craft a unique and captivating visual identity for your site.
- 🌟 Dynamic Visual Effects: Impress your audience with captivating visibility-triggered animations enabled by the Animations module. Engage your visitors with image parallax effects that add depth and interactivity to your content. Create stunning galleries with the Slider feature and effortlessly organize your content with grid layouts using the Grid module, with an Oxone-like animation for grid elements.
- 📷 Masonry Layout: Achieve a captivating and organized layout with the Masonry module, making your content appear in a visually appealing grid.
- 🔦 Lightboxes: Showcase your images and galleries with elegance using the Light-boxes module, offering a user-friendly and engaging lightbox experience.
- 🚀 Smooth Scrolling: Navigate your website effortlessly with the ScrollTo module, offering enhanced, no-config smooth scrolling with a history feature.
- 🎯 Scroll Animations: Bring life to your site with scroll animations using the ScrollControl module, creating engaging and interactive user experiences.
- 📜 Input Enhancements: Elevate user interactions with enhanced input select options provided by the Enhanced input select with choices.js module.
- 🛒 Seamless Integration: Modul R seamlessly integrates with popular WordPress plugins like Gutenberg and WooCommerce. This means you can effortlessly add and manage content, and even set up an online store without breaking a sweat.
In the world of web design, Modul R is your ticket to a future where creativity knows no bounds.
It empowers you to build a website that not only looks fantastic but also performs flawlessly.
Dive into a world of endless customization possibilities, enjoy lightning-fast loading times, and engage your audience with captivating visual effects.
With Modul R, your website is no longer just a site; it's an experience
(batteries 🔋 included)
= Getting started =
* The customizations are grouped into WordPress customizer under "colors" and "modul-r template customizations"
* Create a menu then assign it into the primary navigation
* In Widget section, under footer widgets you could add a widget. (not needed)
* Create a page then go to settings > reading and select the page as static homepage. (not needed)
= How I could benefit by using this template? =
* It is a simple template with good out-of-the-box performance.
* This template was designed to be developer friendly and can be and can be used as a bootstrap to start a much more complex site. if these are your intentions, please install the child theme you can find on git, below is how to do it and a list of gulp tasks that allow you to modify and recompile in this bundled version
= Contribute =
We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
* Reporting a bug
* Discussing the current state of the code
* Submitting a fix
* Proposing new features
We use github to host code, to track issues and feature requests, as well as accept pull requests.
By contributing, you agree that your contributions will be licensed under its GPLv2 License.
[github](https://github.com/erikyo/modul-r)
= More questions? =
You can find a [quick start guide here](https://modul-r.codekraft.it/2019/06/theme-setup/)
== Upgrade Notice ==
= 1.2.0 - Sept 13, 2019 =
* fast forward to fse, lots of new features but no longer compatible with classic editor
= 1.2.0 - Sept 13, 2019 =
* Hudge changes in customizer section... go and check all the new features. From the sass configuration the variables to set the header and sidebar direction have been removed since they are now changed by the customizer
= 1.1.0 - Aug 22, 2019 =
* Menu name change: set the primary menu to "main-menu"
= 1.0.0 - May 11, 2019 =
* First release
== Changelog ==
= 2.0.0 =
* upgrading the theme to full site editing
* Removed the old forms and patterns in favour of the new block styles. All the main functions have been retained
= 1.4.0 =
* Redesigned customisation section!
* Completely revised scss style. Now you can customise the font family and various text properties directly from customiser (with on-the-fly preview)
= 1.3.1 =
* sidebar, masonry and post page style enhancements, improved woocommerce integration
* gulp task which converts all images to webp (both those in the theme and those in /uploads/).
* gulp dependencies and tasks updated (babel 7.15 & gulp-sass 5 with the new dart-sass).
* new options in customizer, with selectable hero height, woo-shop options section
= 1.3.0 =
* header icons fix
= 1.2.9 =
* Dependencies update
* More header and footer options like fullwidth - wide - standard width, transparent header on top option, show media links on footer
* Customizable colors for header and footer
* Enhanced above the fold style
* Fix customizer issues
* New default options array (first line of functions.php)
* New way to manage the responsive breakpoint that enables responsive menu on desktops
* Button color enhanced (and customizable)
= 1.2.5 =
* Dependencies update
* Footer style enhancement
= 1.2.4 =
* Main container width fix on small screens
* Other enhancement or style regressions fixes
= 1.2.3 =
* Submenu header color
* Better primary content width
= 1.2.2 =
* Primary container margin glitch fix
* Enhanced featured image, logo & site title centering
* Hamburger menu animation regression fix
* Responsive style enhancement
* Dependencies update
* Customizer hero opacity option
* Custom color scheme reworked
= 1.2.1 =
* Translations and docs update
* Fixed sidebar and hamburger menu style regression
* Theme option header color, better use of the stored color along the theme
= 1.2.0 =
* revisited customizer section with header, footer, sidebar & homepage configuration
* revisited color scheme (lighter and darker version of the primary and secondary + 6 color gradient white to black)
= 1.1.3 =
* cookie style moved to child theme
= 1.1.2 =
* customizer enhancements and fix
* better menu centering
* admin style
= 1.1.1 =
* new tags
* css fixes
= 1.1.0 =
* Dependencies update
* New customizer option "fullpage hero"
* Customized gutenberg theme colors palette
* Some css fix (mainly responsive style, sidebar, homepage etc)
= 1.0.35 =
* customizer Sidebar option
= 1.0.34 =
* better use of custom color (theme colors were applied to buttons, links, bold text etc)
= 1.0.33 =
* removed author uri
= 1.0.32 =
* better sharing function (with escape fix)
* homepage gfx rework (hero size, blocks distances)
* screenshot update
* if woocommerce plugin isn't active, the button in the homepage will show the "contacts" button otherwise it will show
* WordPress guidelines compliance fixes
= 1.0.31 =
* W3C validated
* SASS sidebar configuration
= 1.0.30 =
* accessibility-ready tag removed
* menu keyboard navigation
* accessibility: added a "role" for the main sections
* above the fold style correctly enqueued
* custom theme colors
* new screenshot
* better microdata / header meta enhancement + rss alternate link
* escape translations
* accessibility tab shortcut (from guidelines 2019)
* gulp file update
* svg support moved to child theme
* search form enhancement
= 1.0.11 =
* WooCommerce support
= 1.0.10 =
* Masonry script update to v3
* Complete removal of css4 vars (at the moment there is no gain in using them, there is problems with the fallback and with the sass integration (which however allows you to do many more things such as color operations)
* Editor style
* Gutenberg blocks style enhancement
* Text typography enhancement
* text domain lowercase (and also renamed the git repos)
* Enhancement of child theme compatibility
* Header, navbar, blocks style optimization (added some customizations features for the header)
* Source code optimization & bug correction
* grid layout with masonry for categories
* function name update
* removal of clean.php
* Js scripts init enhancement
* Gulp task who create the zip needed for the theme upload
* Better wordpress customizer integration
* Vendors javascript path fix
= 1.0.0 =
* First release
== Images Screenshot ==
License: CC0 1.0 Universal (CC0 1.0)
Screenshot Image
https://stocksnap.io/photo/2XGW1D92VH
https://stocksnap.io/photo/QXOAPTCZBF
https://stocksnap.io/photo/XPOAYHCKJV
https://stocksnap.io/photo/ZAXUKJTTZT
== Screenshots ==
1. [https://modul-r.codekraft.it/screenshot.png The homepage layout ]
== Copyright ==
Modul R, Copyright 2019 Codekraft Studio
Modul R is distributed under the terms of the GNU GPL
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the LICENSE file for more details.
== Resources ==
* [animate-css-grid](https://www.npmjs.com/package/animate-css-grid) - @aholachek, [MIT](https://github.com/aholachek/animate-css-grid/blob/master/LICENSE.md)
* [animate](https://www.npmjs.com/package/animate.css) - @daneden, [MIT](https://github.com/animate-css/animate.css/blob/main/LICENSE)
* [choices](https://www.npmjs.com/package/choices.js) - @jshjohnson, [MIT](https://github.com/Choices-js/Choices/blob/master/LICENSE)
* [glightbox](https://www.npmjs.com/package/glightbox) - @biati-digital, [MIT](https://github.com/biati-digital/glightbox/blob/master/LICENSE.md)
* [minimasonry](https://www.npmjs.com/package/minimasonry) - @Spope, [MIT](https://github.com/Spope/MiniMasonry.js/blob/master/LICENSE)
* [swiper](https://www.npmjs.com/package/swiper) - @nolimits4web, [MIT](https://github.com/nolimits4web/swiper/blob/master/LICENSE)