WordPress theme for toukoaalto.fi (version 2017)
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
acf-json
assets
lang
lib
templates
.bowerrc
.editorconfig
.gitignore
.jscsrc
.jshintrc
.travis.yml
404.php
CHANGELOG.md
LICENSE
LICENSE.md
README.md
base.php
bower.json
composer.json
front-page.php
functions.php
gulpfile.js Add gulp-zip and zip task Feb 5, 2017
index.php
package.json
page.php Add Sage as starting theme, add first customizations to front-page Jan 21, 2017
ruleset.xml
screenshot.png
search.php
single.php
style.css
template-custom.php
yarn.lock

README.md

Touko Aalto 2017

WordPress theme for toukoaalto.fi (version 2017) built on Sage

TODO

  • Frontpage highlight posts / special themes for election?

Sage

Build Status devDependency Status

Sage is a WordPress starter theme based on HTML5 Boilerplate, gulp, Bower, and Bootstrap Sass, that will help you make better themes.

Requirements

Prerequisite How to check How to install
PHP >= 5.4.x php -v php.net
Node.js >= 4.5 node -v nodejs.org
gulp >= 3.8.10 gulp -v npm install -g gulp
Bower >= 1.3.12 bower -v npm install -g bower

For more installation notes, refer to the Install gulp and Bower section in this document.

Features

  • gulp build script that compiles both Sass and Less, checks for JavaScript errors, optimizes images, and concatenates and minifies files
  • BrowserSync for keeping multiple browsers and devices synchronized while testing, along with injecting updated CSS and JS into your browser while you're developing
  • Bower for front-end package management
  • asset-builder for the JSON file based asset pipeline
  • Bootstrap
  • Theme wrapper
  • ARIA roles and microformats
  • Posts use the hNews microformat
  • Multilingual ready and over 30 available community translations

Install the Soil plugin to enable additional features:

  • Cleaner output of wp_head and enqueued assets
  • Cleaner HTML output of navigation menus
  • Root relative URLs
  • Nice search (/search/query/)
  • Google CDN jQuery snippet from HTML5 Boilerplate
  • Google Analytics snippet from HTML5 Boilerplate

See a complete working example in the roots-example-project.com repo.

Theme installation

Install Sage by copying the project into a new folder within your WordPress themes directory.

Make sure Composer has been installed before moving on.

Install Sage using Composer from your WordPress themes directory (replace your-theme-name below with the name of your theme):

# @ example.com/site/web/app/themes/
$ composer create-project roots/sage your-theme-name 8.5.0

Theme setup

Edit lib/setup.php to enable or disable theme features, setup navigation menus, post thumbnail sizes, post formats, and sidebars.

Theme development

Sage uses gulp as its build system and Bower to manage front-end packages.

Install gulp and Bower

Building the theme requires node.js. We recommend you update to the latest version of npm: npm install -g npm@latest.

From the command line:

  1. Install gulp and Bower globally with npm install -g gulp bower
  2. Navigate to the theme directory, then run npm install
  3. Run bower install

You now have all the necessary dependencies to run the build process.

Available gulp commands

  • gulp — Compile and optimize the files in your assets directory
  • gulp watch — Compile assets when file changes are made
  • gulp --production — Compile assets for production (no source maps).

Using BrowserSync

To use BrowserSync during gulp watch you need to update devUrl at the bottom of assets/manifest.json to reflect your local development hostname.

For example, if your local development URL is http://project-name.dev you would update the file to read:

...
  "config": {
    "devUrl": "http://project-name.dev"
  }
...

If your local development URL looks like http://localhost:8888/project-name/ you would update the file to read:

...
  "config": {
    "devUrl": "http://localhost:8888/project-name/"
  }
...

Documentation

Sage documentation is available at https://roots.io/sage/docs/.

Contributing

Contributions are welcome from everyone. We have contributing guidelines to help you get started.

Community

Keep track of development and community news.