Semantic UI for WordPress

The Semantic UI WordPress starter theme.

This project incorperates Semantic UI into a developer theme for WordPress. This project also includes some of my favorite techniques for creating fast, responsive, and easy-to-maintain themes for WordPress. Please keep in mind this theme is meant to be developed for your specific application; and is not meant to be used "as-is."

Download:

Copyright © 2014 Nicholas Jordon — All Rights Reserved

Features

Semantic UI
Responsive Design | Google Web Fonts
Image Optimization | Theme Options Page | Woocommerce Support
Font Awesome | Webicons | Gulp | LESS/SASS Support | Normalize CSS
jQuery From CDN | Google Microdata | Unit Testing
Highlight.js | Keyboard Shortcuts
Well Commented Code

Installation

Requirements

• PHP 5.4 or later
• WordPress 3.9.0 or later

Install Guide

1. Download the release version of the theme
2. Unzip to your wp-content/themes directory
3. Set the theme to "active" in your WordPress dashboard

Building From Source

To build from source you need to have Node.js installed and in your $path (win/mac/unix). You should also have PHPUnit and Composer installed and in your $path as well.

Mac & Unix:

1. Download or clone the master branch
2. Open your command line and navigate to where you deployed the code
3. Run sudo npm install && sudo npm install -g gulp enter your password and then wait for it to finish.
4. Run gulp to see a list of available tasks. Running gulp build will regenerate /build from scratch.

Windows:

1. Download or clone the master branch
2. Open your command line and navigate to where you deployed the code
3. Run npm install && npm install -g gulp and then wait for it to finish.
4. Run gulp to see a list of available tasks. Running gulp build will regenerate /build from scratch.

Usage

This is a developer theme designed to be developed for your specific application. The default state of this theme is meant to be plain & organized; while not being bias to any particular design. (thus everything defaults to black and white)

Designing Pages

In this developer theme there are 5 important parts to generate a page:

• Templates
• Includes
• Layouts
• Contents
• Assets

A template file decides which layout to use based on the type of content that is being requested. A template file will typically have no HTML or very little HTML, but should get all the necessary includes for the page.

A include file adds functionality to a page and should have no output unless a function or method is called in a template, layout, or content file. Include files are usually used for API classes and libararies, but can be used for anything related to functionality.

A layout file decides where sidebars and other content is inserted. Layout files should usually have a fair or large amount of HTML content, as well as a few functionality calls; such as calling a comments thread or specific form to be generated. The header and footer is usually inserted via the layout file.

A content file generates a group of elements and often has functionality calls for specifc elements, such as dynamic text and images. Content files typically output the most text, and usually have a large amount of HTML.

Assets are typically static files that are commonly used. These files are usually images, stylesheets, fonts, and javascript files, and might also include other files that need to be precompiled before they can be used. (such as LESS and SASS/SCSS files)

##Contributing

Contributing to Semantic UI

Visit this page to learn how to contribute to Semantic UI.

Contributing to This WordPress Theme

Contributing via Suggestions:
The best way to submit a suggestion is to open an issue on Github and prefix the title with [Suggestion]. Alternatively, you can email your suggestions to projectcleverweb (at) gmail (dot) com.

Contributing via Reporting Problems:
All problems must be reported via Github's issue tracker.

Contributing via Code:

1. Fork the repo on Github: github.com/ProjectCleverWeb/Semantic-UI-WordPress
2. Make your changes.
3. Send a pull request to have your changes reviewed.

License

The Semantic UI for WordPress documentation by Nicholas Jordon is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License. To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/4.0/

The Semantic UI for WordPress source code by Nicholas Jordon is licensed under the MIT License. To view a copy of this license, visit http://opensource.org/licenses/MIT

Semantic UI is not subject to this work's copyright & license(s). Other works that may also be included with this work are also not subject to this work's copyright & license(s). Copyright & licensing of all included works are determined by their respective owners.