forked from maddisondesigns/Quark
-
Notifications
You must be signed in to change notification settings - Fork 0
/
readme.txt
334 lines (254 loc) · 18.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
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
=== Quark ===
Contributors: ahortin
Donate link: http://quarktheme.com
Tags: one-column, two-columns, right-sidebar, custom-background, custom-header, custom-menu, editor-style, featured-image-header, featured-images, full-width-template, microformats, post-formats, sticky-post, theme-options, threaded-comments, translation-ready
Requires at least: 3.6
Tested up to: 4.9
Stable tag: 1.4.1
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
Quark is your basic building block for creating beautiful, responsive custom themes. It's not a convoluted or confusing framework that's hard to learn or even harder to modify. It's a simple and elegant starter theme built on HTML5 & CSS3. Its base is a responsive, 12 column grid. It incorporates custom theme options that are easy to modify, a set of common templates, support for WordPress Post Formats and the gorgeous, retina friendly Font Awesome icon font. Quark is WooCommerce compatible, Multilingual Ready (WPML) and translated into Spanish, German and French. Quark is also compatible with popular page builders such as Elementor, Divi Builder, Beaver Builder, the SiteOrigin Page Builder and Visual Composer.
== Description ==
Quark is your basic building block for creating beautiful, responsive custom themes. It's not a convoluted or confusing framework that's hard to learn or even harder to modify. It's a simple and elegant starter theme built on HTML5 & CSS3. It's based on the Underscores (_s) and TwentyTwelve themes, so that means not only is it flexible, it's extremely easy to customise.
If you do decide to use a child theme with Quark, there's no need to use CSS @import or even enqueue the parent stylesheet. Quark will automatically enqueue the parent stylesheet for you. How nice is that!
Quark's base is a responsive, 12 column grid. It uses Normalize to make sure that browsers render all elements more consistently and Mordernizr for detecting HTML5 and CSS3 browser capabilities along with some default stylings from HTML5 Boilerplate.
It incorporates the [Options Framework](http://wptheming.com/options-framework-theme/) by Devin Price to make it super easy to add custom Theme Options as well as the gorgeous [Font Awesome](http://fortawesome.github.io/Font-Awesome/) icon font by Dave Gandy.
The main navigation uses the standard WordPress menu. Support for dropdown menus is included by default. If you'd like to envoke a button toggle for the main navigation menu on small screens, simply uncomment the two lines from the quark_scripts_styles() function within functions.php to register and enqueue the necessary javascript file, and BAM! You're done!
If you're looking to build an eCommerce website, Quark now supports WooCommerce. When WooCommerce is activated, an extra tab is displayed within the Theme Options page that provides options to show or hide the sidebar on the default WooCommerce templates, along with the choice to remove the built-in WooCommerce breadcrumbs.
Templates
Quark includes a set of your most common theme templates, including templates for Full-Width pages, Left Sidebar, Right Sidebar (default), Front-Page, Tag, Categories, Authors, Search, Posts Archive and 404.
If you're using one of the many page builder plugins that are available, such as Elementor, Divi Builder, Beaver Builder, the SiteOrigin Page Builder or Visual Composer, try using the Page Builder Full-Width Template or the Page Builder Boxed Template. The Page Builder Full-Width Template is a true full browser width template while the Page Builder Boxed Template contains your content in a boxed layout. If you want a completely blank full-width page with no header or footer sections, such as for a landing page, then there is also a Page Builder Blank Template. Depending which Page Builder plugin that you're using, you may find that one template provides a better layout than the other.
Post Formats
All the standard WordPress Post Formats are supported. These include; Aside, Gallery, Link, Image, Quote, Status, Video, Audio, Chat and of course, your standard post.
Widgets
Widgets are a great way of adding extra content to your site and Quark has a whole assortment of them.
Main Sidebar: Appears in the sidebar on posts and pages except the optional Homepage template, which has its own widgets
Blog Sidebar: Appears in the sidebar on the blog and archive pages only
Single Post Sidebar: Appears in the sidebar on single posts only
Page Sidebar: Appears in the sidebar on pages only
The Front Page Banner Widget areas are dynamic! You can use up to two of these and they'll magically space themselves out evenly. For example, if you only add widgets into the First Front Page Banner Widget Area, then it will expand the full width of the page. However, if you add widgets to both Front Page Banner Widget areas, they'll magically space themselves out over two equal columns.
First Front Page Banner Widget: Appears in the banner area on the Front Page
Second Front Page Banner Widget: Appears in the banner area on the Front Page
The Front Page Widget areas are dynamic! You can use up to four of these and they'll magically space themselves out evenly. For example, if you only add widgets into the First Front Page Widget Area, then it will expand the full width of the page. However, if you add widgets to all four Front Page Widget Areas, they'll magically space themselves out over four equal columns.
First Homepage Widget Area: Appears when using the optional homepage template with a page set as Static Front Page
Second Homepage Widget Area: Appears when using the optional homepage template with a page set as Static Front Page
Third Homepage Widget Area: Appears when using the optional homepage template with a page set as Static Front Page
Fourth Homepage Widget Area: Appears when using the optional homepage template with a page set as Static Front Page
The Footer Widget areas are dynamic! You can use up to four of these and they'll magically space themselves out evenly. For example, if you only add widgets into the First Footer Widget Area, then it will expand the full width of the page. However, if you add widgets to all four Footer Widget Areas, they'll magically space themselves out over four equal columns.
First Footer Widget Area: Appears in the footer sidebar
Second Footer Widget Area: Appears in the footer sidebar
Third Footer Widget Area: Appears in the footer sidebar
Fourth Footer Widget Area: Appears in the footer sidebar
Custom Header
The Default logo can be easily changed using the Custom Header feature. You change this in the Appearance > Header menu option
Custom Background
The background pattern can be changed using the Custom Background feature. You change this in the Appearance > Background menu option
Theme Options
Additional Theme Options can be found in the Appearance > Theme Options menu option. These include options for:
Specifying the URL's for various social media networks
Specifying the banner background image & color
Specifying the footer color
Changing the footer credit text
Hiding the sidebar on WooCommerce templates
Hiding the WooCommerce breadcrumbs
Multilingual Ready (WPML)
Using the WordPress Multilingual Plugin (WPML) it's now easy to build multilingual sites. With WPML you can translate pages, posts, custom types, taxonomy, menus and even the theme’s texts.
WooCommerce Support
WooCommerce is a WordPress eCommerce toolkit that helps you sell anything. Beautifully. Turn your website into a powerful eCommerce site by installing the WooCommerce plugin by WooThemes.
== Installation ==
There are three ways to install your theme. It can be installed by manually uploading the files to the themes folder using an FTP application,
it can be installed by downloading from the WordPress Theme Directory within the Dashboard or it can be installed by uploading the theme zip
file that you downloaded.
Use the following instructions to install & activate Quark using your preferred method.
Manual installation:
1. Unzip the files from the Quark zip file that you downloaded
2. Upload the Quark folder to your /wp-content/themes/ directory
3. Click on the Appearance > Themes menu option in the WordPress Dashboard
4. Click the Activate link below the Quark preview thumbnail
Install from the WordPress Theme Directory:
1. Click on the Appearance > Themes menu option in the WordPress Dashboard
2. Click the Install Themes tab at the top of the page
3. Type 'Quark' in the search field, without the quotes, and then click the Search button
4. Click the Install Now link below the Quark preview thumbnail
5. Once the theme has been installed, click the Activate link
Install by uploading the theme zip file:
1. Click on the Appearance > Themes menu option in the WordPress Dashboard
2. Click the Install Themes tab at the top of the page
3. Click on the Upload link just below the two tabs at the top of the page
4. Click the Browse button, browse to the folder that contains the theme zip file, select it and then click the Open button
5. Click the Install Now button
6. Once the theme has been installed, click the Activate link
== Getting Started ==
Since Quark is a starter theme to kick off your own awesome theme, the first thing you want to do is copy the quark theme folder
and change the name to something else. You'll then need to do a three-step find and replace on the name in all the templates.
1. Search for quark inside single quotations to capture the text domain.
2. Search for quark_ to capture all the function names.
3. Search for quark with a space before it to replace all the occurrences of it in comments.
(You'd replace this with the capitalized version of your theme name.)
or, to put it another way...
Search for:'quark'
Replace with:'yourawesomethemename'
Search for:quark_
Replace with:yourawesomethemename_
Search for: quark
Replace with: YourAwesomeThemeName
Lastly, update the stylesheet header in style.css and either update or delete this readme.txt file.
== License ==
Quark is licensed under the [GNU General Public License version 2](http://www.gnu.org/licenses/old-licenses/gpl-2.0.html).
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 2 of the License, or (at your option) any later version.
== Credits ==
Quark utilises the following awesomeness:
[Options Framework](http://wptheming.com/options-framework-theme), which is licensed under the GPLv2 License
[Modernizr](http://modernizr.com), which is licensed under the MIT license
[Normalize.css](https://github.com/necolas/normalize.css), which is licensed under the MIT license
[jQuery Validation](http://bassistance.de/jquery-plugins/jquery-plugin-validation) which is dual licensed under the MIT license and GPL licenses
[Font Awesome](http://fortawesome.github.io/Font-Awesome) icon font, which is licensed under SIL Open Font License and MIT License
[PT Sans font](http://www.google.com/fonts/specimen/PT+Sans), which is licensed under SIL Open Font License 1.1
[Arvo font](http://www.google.com/fonts/specimen/Arvo), which is licensed under SIL Open Font License 1.1
== Changelog ==
= 1.4.1 =
- Update styles for cookie consent on comment form
= 1.4 =
- Update Modernizr to v3.5.0
- Update jQuery Validate to v1.17.0
- Update usage of loop_shop_per_page filter so it's only used if WooCommerce is less than v3.3. Please check your Customizer > WooCommerce > Product Catalog settings after updating.
- Remove create_function() call as it's been deprecated as of PHP 7.2.0. Props @swiffer
= 1.3.7 =
- Fixed bold and italic styles so neither is cancelling the other out when used together in either order (props @mikeconaty for the suggestion)
= 1.3.6 =
- Fixed issue with WooCommerce Category and Tag templates ignoring the Shop sidebar theme option. Props @creativemode for reporting the issue.
- Added hook (quark_above_banner) inside banner area so that it's easier to add content inside the banner
- Updated description to include compatibility with the Elementor Page Builder
= 1.3.5 =
- Fixed issue with comment form not displaying on Posts that are using the Left Hand Sidebar template
- Fixed margins & padding on WooCommerce 3.0 product galleries
- Added support for WooCommerce 3.0 product galleries
- Removed comment form from pages using Full-width template pages
- Updated the WooCommerce pagination so that it matches the blog pagination
= 1.3.4 =
- Added extra function_exists() checks to allow for easier overriding
- Added ability for Left Sidebar Page Template to be used on Posts as well as pages (in WordPress 4.7+)
- Fixed gallery layout so that it is cleared properly
- Fixed issue with content not displaying properly on Single Post when a custom excerpt has been written
- Fixed Background & Header links on Theme Options page to work with Customizer. Props @swiffer
= 1.3.3 =
- Fixed missing ratings when leaving a review via the WooCommerce product review tab
- Added new blank page builder template
- Added new social icon options for CodePen, Reddit, Twitch, Slack, Snapchat, Stack Overflow, Vimeo, Vine
- Added aria-hidden to icons to hide from screen readers
- Removed word-break from widgets. Props to Aaron Payne (@awdience) for pointing out an issue it was causing in stoopid IE
- Removed gradients from buttons. Gradients are sooo last year!
- Updated Font Awesome icon font to v4.6.3
- Updated Normalize to v4.1.1
- Updated Modernizr to v3.1.1
- Updated Post archive page to display excerpt if one has been added
= 1.3.2 =
- Fixed display of Related Products on Single Product page
- Added filter for displaying shortcodes properly in footer content
- Added theme support for HTML5 markup for the search forms, comment forms, comment lists, gallery, and caption
- Added new page builder templates
= 1.3.1 =
- Updated styles for WooCommerce 2.3
- Added automatic enqueueing of parent stylesheet for child themes.
- Added dependencies when enqueing styles to ensure they're loaded in correct order
- Added theme option to set the number of products to display on the WooCommerce shop page
= 1.3 =
- Updated normalize.css to v3.0.2
- Updated Options Framework to v1.9.1
- Fixed focus on footer links so they're visible
- Added French translation. Props @arpinfo
- Added support for new title-tag
- Added support for WooCommerce
= 1.2.12 =
- Updated Modernizr to v2.8.3
- Updated Font Awesome icon font to v4.2
- Updated jQuery Validation to v1.13.0
- Added SlideShare icon to the theme options
= 1.2.11 =
- Updated Modernizr to v2.8.2
- Updated Font Awesome icon font to v4.1
- Added German translation. Props Tino Groteloh
- Added WPML compatibility
= 1.2.10 =
- Updated normalize.css to v3.0.1
- Updated Modernizr to v2.7.2
- Fixed grid percentages
- Added RSS icon to the theme options
- Added Spanish translation. Props @amieiro
- Updated img element to add vertical-align so images are better aligned
= 1.2.9 =
- Removed Google Analytics script as requested by theme reviewer. This is best left for plugins so please ensure you add one if you were using this feature
= 1.2.8 =
- Fixed undefined function error on sanitization methods that were introduced due to Options Framework changing to class based code
= 1.2.7 =
- Updated Font Awesome icon font to v4.0.3
- Updated Options Framework to v1.7.1
- Updated Modernizr to v2.7.1
- Updated comments to be enclosed in <section> rather than <div>. Props @gnotaras
- Removed pubdate from post/comment meta. Replaced with itemprop
- Removed invalid attribute from email input box. Props @gnotaras
= 1.2.6 =
- Updated normalize.css to v2.1.3
- Updated Font Awesome icon font to v4.0.0 (incl. renaming font classes as per their new naming convention)
- Removed Font Awesome More font as it's now outdated and no longer needed
- Removed minimum-scale & maximum-scale from viewport meta tag
- Fixed extra period in blockquote style. Props @angeliquejw
- Fixed 'Skip to main content' accessibility link
- Added extra theme option to allow social media links to open in another browser tab/window
- Added extra social media profiles in the theme options for Dribbble, Tumblr, Bitbucket and Foursquare
- Added check for 'Comment author must fill out name and e-mail' setting when validating comments
= 1.2.5 =
- Updated normalize.css to v2.1.2
- Updated Font Awesome icon font to v3.2.1
- Updated theme short description
- Updated Post Format templates to contain Author bio
- Updated _e() references to esc_html_e() to ensure any html added into translation file is neutralised
- Updated __() references to esc_html__() to ensure any html added into translation file is neutralised
- Added template for displaying Author bios
- Added extra use of wp_kses() to ensure only authorised HTML is allowed in translations
- Added loading of Google Fonts in TinyMCE Editor
- Added display of Featured Image on Pages, if used
- Added extra styling to make sure non-breaking text in the title, content, and comments doesn't break layout
- Removed login_errors filter. This is best left for plugins
- Removed audio.js since audio functionality is now part of core
- Removed use of clearfix class as containers will now automatically clear
= 1.2.4 =
- Updated strings that weren't wrapped in gettext functions for translation purposes
- Updated Text Domain in Options Framework
- Added esc_url() when using site URL in header
- Added sanitation when outputting theme options
- Fixed bottom margin on blog articles on homepage
- Fixed text colour in homepage banner
= 1.2.2 =
- Updated blockquote.pull-right style
- Updated footer smallprint link colour
- Fixed display of site name in header area if no Custom Header is specified (ie. no logo image)
- Removed wp_head hook that removes the WP version number. This is best left for plugins
- Updated enqueing of scripts. Scripts that are being depended on, will automatically get enqueued so no need to enqueue them manually.
- Added max-with of 100% to select form fields. Field no longer extends past container in sidebar
- Fixed padding in main content area when homepage is a blog, so pagination doesn't touch footer
- Changed fonts so they're called from Google Fonts rather than local
- Removed unrequired font files from fonts folder
= 1.2.1 =
- Fixed sidebars
- Updated description in stylesheet
- Updated IE filters in btn class
- Added extra class when styling frontpage widgets
= 1.2 =
- Updated Options Framework to version 1.5.2
- Replaced Museo font with Arvo font
- Replaced background images
- Replaced Responsive Grid System with own custom grid
- Replaced IcoMoon icon font with Font Awesome icon font
- Added GitHub social icon theme option
= 1.1 =
- Changed margin and removed padding on .row class and consolidated html to remove extra container elements from templates
- Removed unnecessary comments from style.css
- Updated navigation margins in media queries
- Updated margin, padding & font-size with matching rem values, where missing
- Updated readme.txt with Getting Started information
- Removed Google Analytics code from footer and enqueued with other scripts
- Initial Repository Release
= 1.0 =
- Initial version