Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jeffsee55/sage-runfurman

Last synced: 12 days ago
JSON representation

Host: GitHub
URL: https://github.com/jeffsee55/sage-runfurman
Owner: jeffsee55
License: mit
Created: 2015-06-02T20:34:29.000Z (over 9 years ago)
Default Branch: master
Last Pushed: 2015-06-02T20:36:21.000Z (over 9 years ago)
Last Synced: 2024-10-04T19:44:20.212Z (about 1 month ago)
Language: PHP
Size: 36.8 MB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md

Awesome Lists containing this project

README

        # [Sage](https://roots.io/sage/)

[![Build Status](https://travis-ci.org/roots/sage.svg)](https://travis-ci.org/roots/sage)

[![devDependency Status](https://david-dm.org/roots/sage/dev-status.svg)](https://david-dm.org/roots/sage#info=devDependencies)

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

* Source: [https://github.com/roots/sage](https://github.com/roots/sage)

* Homepage: [https://roots.io/sage/](https://roots.io/sage/)

* Documentation: [https://roots.io/sage/docs/](https://roots.io/sage/docs/)

* Twitter: [@rootswp](https://twitter.com/rootswp), [@retlehs](https://twitter.com/retlehs), [@swalkinshaw](https://twitter.com/swalkinshaw), [@Foxaii](https://twitter.com/Foxaii), [@c2foryou](https://twitter.com/c2foryou), [@austinpray](https://twitter.com/austinpray)

* Newsletter: [Subscribe](http://roots.io/subscribe/)

* Forum: [https://discourse.roots.io/](https://discourse.roots.io/)

## Requirements

| Prerequisite    | How to check | How to install

| --------------- | ------------ | ------------- |

| PHP >= 5.4.x    | `php -v`     | [php.net](http://php.net/manual/en/install.php) |

| Node.js 0.12.x  | `node -v`    | [nodejs.org](http://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](#install-gulp-and-bower) section in this document.

## Features

* [gulp](http://gulpjs.com/) build script that compiles both Sass and Less, checks for JavaScript errors, optimizes images, and concatenates and minifies files

* [BrowserSync](http://www.browsersync.io/) for keeping multiple browsers and devices synchronized while testing, along with injecting updated CSS and JS into your browser while you're developing

* [Bower](http://bower.io/) for front-end package management

* [asset-builder](https://github.com/austinpray/asset-builder) for the JSON file based asset pipeline

* [Sass](https://github.com/twbs/bootstrap-sass) [Bootstrap](http://getbootstrap.com/)

* [Theme wrapper](https://roots.io/sage/docs/theme-wrapper/)

* ARIA roles and microformats

* Posts use the [hNews](http://microformats.org/wiki/hnews) microformat

* [Multilingual ready](https://roots.io/wpml/) and over 30 available [community translations](https://github.com/roots/sage-translations)

Install the [Soil](https://github.com/roots/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](http://html5boilerplate.com/)

* Google Analytics snippet from [HTML5 Boilerplate](http://html5boilerplate.com/)

## Installation

Clone the git repo - `git clone https://github.com/roots/sage.git` and then rename the directory to the name of your theme or website.

If you don't use [Bedrock](https://github.com/roots/bedrock), you'll need to add the following to your `wp-config.php` on your development installation:

```php

define('WP_ENV', 'development');

```

## Configuration

Edit `lib/config.php` to enable or disable theme features

Edit `lib/init.php` to setup navigation menus, post thumbnail sizes, post formats, and sidebars.

## Theme development

Sage uses [gulp](http://gulpjs.com/) as its build system and [Bower](http://bower.io/) to manage front-end packages.

### Install gulp and Bower

Building the theme requires [node.js](http://nodejs.org/download/). We recommend you update to the latest version of npm: `npm install -g npm@latest`.

From the command line:

1. Install [gulp](http://gulpjs.com) and [Bower](http://bower.io/) 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:

```json

...

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

```json

...

  "config": {

    "devUrl": "http://localhost:8888/project-name/"

  }

...

```

## Documentation

Sage documentation is available at [https://roots.io/sage/docs/](https://roots.io/sage/docs/).

## Contributing

Contributions are welcome from everyone. We have [contributing guidelines](CONTRIBUTING.md) to help you get started.

## Community

Keep track of development and community news.

* Participate on the [Roots Discourse](https://discourse.roots.io/)

* Follow [@rootswp on Twitter](https://twitter.com/rootswp)

* Read and subscribe to the [Roots Blog](https://roots.io/blog/)

* Subscribe to the [Roots Newsletter](https://roots.io/subscribe/)