Skip to content

Latest commit

 

History

History
executable file
·
90 lines (60 loc) · 3.58 KB

README.md

File metadata and controls

executable file
·
90 lines (60 loc) · 3.58 KB

ALPS WordPress Theme

ALPS specific documentation to come. ALPS theme is based off of the WordPress starter theme, Sage.

Sage is a WordPress starter theme based on HTML5 Boilerplate, gulp, and 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 0.12.x node -v nodejs.org
gulp >= 3.8.10 gulp -v npm install -g gulp

For more installation notes, refer to the Install gulp 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
  • asset-builder for the JSON file based asset pipeline
  • Theme wrapper
  • ARIA roles and microformats
  • Posts use the hNews microformat
  • Multilingual ready and over 30 available community translations

Theme installation via WordPress Admin Panel

  1. In your WordPress admin panel, navigate to Appearance->Themes
  2. Click Add New
  3. Click Upload Theme
  4. Upload the zip file that you downloaded.

Theme development

Sage uses gulp as its build system.

Install gulp

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 globally with npm install -g gulp
  2. Navigate to the theme directory, then run npm 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://alps-wp.dev you would update the file to read:

...
  "config": {
    "devUrl": "http://alps-wp.dev"
  }
...

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.