Giter Club home page Giter Club logo

barebones-fse's Introduction

barebones

A lightweight and skeletal WordPress boilerplate theme for HTML5 and beyond. There's lots of these out there but most themes include lots of bloat and files which you might not necessarily need, so we thought we would create our own which is great as a starting point with powerful features to encourage rapid development for most projects.

Features

  • Reset, normalisation and base font/form styles
  • 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
  • jQuery plugin agnostic
  • 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
  • Scss compiling and watching, css minification support
  • Rollup.js for js for smallest possible bundles
  • Image optimisation using imagemin.
  • Base mobile nav out of the box

Installation

Clone the barebones repositories into your WordPress /wp-content/themes/ directory:

git clone https://github.com/benchmarkstudios/barebones
cd barebones

To include all its optional submodules (Simple Grid included):

git submodule init
git submodule update

Dependencies

Install Dependencies:

  npm install

.. 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 Dependencies, you have haven't done yet:

npm install

Then run:

Tasks
gulp to compile (All tasks)
gulp watch to watch
gulp images to optimise images
gulp styles to compile styles
gulp scripts to compile scripts
gulp build to create a build (minification, removes map files and comments)

This will execute all the Gulp tasks on the gulpfile.babel.js.

Configuration for Gulp

Some of the configuration can be done in config.barebones.js file, such as base source and public paths, along with scripts file paths for multiple bundles.

Of course, feel free to modify gulpfile itself.

Images

Drop all your images into assets/images. 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

Compatible with WordPress 3.2 and above, but always use the latest version.

Browser Support

  • Internet Explorer 8.0+
  • Firefox 3.0+
  • Safari 4.0+
  • Chrome 14.0+
  • Opera 10.0+

Tips & Tricks

SVG Fallbacks

Most likely if you need to support IE8

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" />

barebones-fse's People

Contributors

mikefrancis avatar pdcreis avatar lukasjuhas avatar bmsdan avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.