Giter Club home page Giter Club logo

shoestrap's Introduction

Shoestrap: Roots on steroids!

We Forked the Roots theme and added lots of options, hooks and actions in there, making it a theme that anyone can use and customize their site to a great extent, making it their own. Our goal was to make it easier for developers to create and prototype sites without any coding and with just a few clicks.

Options Panel

We have included the ReduxFramework into Shoestrap so you can easily customize all the aspects of this theme (props @@dovy).

Automated Compiling

Using the Options Panel, users can change most of the variables available on the core of Bootstrap 3, and the php.less compiler generates the theme CSS for on the fly. We tried to keep the number of options to a minimum (there are still more than 150 settings available) so we customized the variables compiling and most variables interact with each-other to generate the values of the variables that we did not include. This way you can focus on what's important and be sure that your site will look great. We also made sure that the compiler is multisite-compatible, since each site has its own stylesheet in a network, with the site ID appended to it.

But that's not all, we also added many options to change the layout of your site, add a 2nd sidebar, add logos, background images, patterns and more.

Widget Areas

We included a number of widget areas in the shoestrap theme. These include:

  • Primary Sidebar
  • Secondary Sidebar
  • Jumbotron
  • Header Area
  • 4 Footer Widget Areas
  • 5 Slide-Down Widget areas (sliding-down from the pripary navbar)

Developer-friendly

Developers will also find this theme easy to use and develop on, since we made it completely modular and easy extendable.

  • Everything on this theme is a module (including the compiler). All you have to do to create a new module is create a new folder in /lib/modules/ and add a module.php file in there. The file will automatically be detected and included, you don't have to do anything more than that.
  • Using our hooks and actions, instead of hacking the theme files developers can simply create a plugin and override the default templates and template parts, or inject their custom content wherever they want.

Example:

Want to override the template for single posts? No problem! All you have to do is add this to your custom plugin:

function my_custom_single_content() {
	// CONTENT HERE
}
add_action( 'shoestrap_content_single_override', 'my_custom_single_content' );

Contributing

Everyone is welcome to help contribute and improve this project. There are several ways you can contribute:

  • Reporting issues (please read issue guidelines)
  • Suggesting new features
  • Writing or refactoring code
  • Fixing issues
  • Replying to questions on the forum

Support

Use the Shoestrap Forums to ask questions and get support.

Built with Grunt

Roots is a WordPress starter theme based on HTML5 Boilerplate & Bootstrap that will help you make better themes.

Installation

Clone the git repo - git clone git://github.com/roots/roots.git - or download it and then rename the directory to the name of your theme or website. Install Grunt, and then install the dependencies for Roots contained in package.json by running the following from the Roots theme directory:

npm install

Reference the theme activation documentation to understand everything that happens once you activate Roots.

Theme Development

After you've installed Grunt and ran npm install from the theme root, use grunt watch to watch for updates to your LESS and JS files and Grunt will automatically re-build as you write your code.

Configuration

Edit lib/config.php to enable or disable support for various theme functions and to define constants that are used throughout the theme.

Edit lib/init.php to setup custom navigation menus and post thumbnail sizes.

Documentation

  • Roots 101 — A guide to installing Roots, the files and theme organization
  • Theme Wrapper — Learn all about the theme wrapper
  • Build Script — A look into the Roots build script powered by Grunt
  • Roots Sidebar — Understand how to display or hide the sidebar in Roots

Features

  • Organized file and template structure
  • HTML5 Boilerplate's markup along with ARIA roles and microformat
  • Bootstrap
  • Grunt build script
  • Theme activation
  • Theme wrapper
  • Root relative URLs
  • Clean URLs with a plugin (no more /wp-content/)
  • All static theme assets are rewritten to the website root (/assets/*)
  • Cleaner HTML output of navigation menus
  • Cleaner output of wp_head and enqueued scripts/styles
  • Nice search (/search/query/)
  • Image captions use <figure> and <figcaption>
  • Example vCard widget
  • Posts use the hNews microformat
  • Multilingual ready (Brazilian Portuguese, Bulgarian, Catalan, Danish, Dutch, English, Finnish, French, German, Hungarian, Indonesian, Italian, Korean, Macedonian, Norwegian, Polish, Russian, Simplified Chinese, Spanish, Swedish, Traditional Chinese, Turkish, Vietnamese, Serbian)

Contributing

Everyone is welcome to help contribute and improve this project. There are several ways you can contribute:

  • Reporting issues (please read issue guidelines)
  • Suggesting new features
  • Writing or refactoring code
  • Fixing issues
  • Replying to questions on the forum

Support

Use the Roots Discourse to ask questions and get support.

githalytics.com alpha

shoestrap's People

Contributors

aristath avatar retlehs avatar dovy avatar swalkinshaw avatar fovoc avatar foxaii avatar weslly avatar coreywagehoft avatar jeff-lewis avatar leoj3n avatar johnraz avatar lautreamont3 avatar dvregan avatar cabgfx avatar zensimilia avatar mwrather avatar magox-git avatar fingli avatar novrian avatar limenet avatar leocolomb avatar hariadi avatar hanscz avatar emreerkan avatar benklocek avatar adamnbowen avatar michael-tourneur avatar waitxd avatar tricil avatar sfradel avatar

Watchers

James Cloos avatar  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.