solid v3 setup, wip

This commit is contained in:
Lukas Juhas 2017-06-06 15:23:36 +01:00
parent b02b2f2519
commit 7e87836ada
62 changed files with 665 additions and 4867 deletions

View file

@ -5,17 +5,17 @@ A lightweight and skeletal WordPress boilerplate theme for HTML5 and beyond. The
## Features
* Reset, normalisation and base font/form styles
* Sass Boilerplate - semantically named files, organised by folders, all compiled into a single file
* Scss Boilerplate - semantically named files, organised by folders, all compiled into a single file
* Semantic use of HTML5 elements, includes Google HTML5 shiv
* WAI-ARIA role ready
* Comes pre-bundled with cached CDN version of jQuery
* jQuery plugin agnostic
* Laravel Elixir to define/customize and run basic Gulp tasks
* Basic template files
* Customised functions.php adding theme support for high customisation
* Minimised HTTP requests for high Web Performance
* Localised strings for multiple language support
* Sass compiling and watching, css minification and live reload support
* Scss compiling and watching, css minification support
* Rollup.js for js for smallest possible bundles
* Image optimisation using imagemin.
## Installation
@ -31,23 +31,26 @@ To include all its optional submodules ([Simple Grid](https://github.com/benchma
#### Dependencies
* [Node.js](http://nodejs.org)
* [Gulp](http://gulpjs.com)
* [Gulp Imagemin](https://github.com/sindresorhus/gulp-imagemin)
* [Laravel Elixir](https://github.com/laravel/elixir)
Install Dependencies:
```
npm install
```
### Using Gulp and Laravel Elixir
.. or with yarn:
```
yarn
```
### Using Gulp
Install Gulp as a global NPM package, if you don't have it already on your machine:
npm install --global gulp
Install Laravel Elixir:
Install Dependencies, you have haven't done yet:
npm install
Edit your gulpfile.js adding the required tasks (check the [Laravel Elixir](http://laravel.com/docs/master/elixir) documentation for further information).
Then run:
gulp
@ -58,11 +61,20 @@ Then run:
*to watch*
gulp --production
gulp images
*to minify*
*to optimise images*
This will execute all the Gulp tasks on the gulpfile.js.
gulp build
*to create a build (minification, removes map files and comments)*
This will execute all the Gulp tasks on the gulpfile.babel.js.
### Images
Drop all your images into assets/imagess. When running gulp tasks, they will be automatically
optimised and output files will available in img folder in the root of the theme.
## WordPress Support
@ -75,3 +87,21 @@ Compatible with WordPress 3.2 and above, but always use the latest version.
* Safari 4.0+
* Chrome 14.0+
* Opera 10.0+
## Tips & Tricks
### SVG Fallbacks
*CSS*
```
...
background-size: 120px 15px;
background-image: url(/img/fallback.png);
background-image: linear-gradient(transparent, transparent), url(/img/image.svg);
...
```
*HTML*
```
<img src="/img/logo.svg" onerror="this.src='/img/logo.png'" alt="image" />
```