caleorourke / exhibit Goto Github PK

exhibit is a one-page template designed specifically for hosting on GitHub Pages and serving locally using Jekyll.

exhibit requires the minimum versions of Node and Ruby below.

• Node 0.10.30
• Ruby 2.0

Run the commands below to determine which versions are currently installed.

# each command returns a version number
$ node --version
$ ruby -v

Clone exhibit from the gh-pages branch on GitHub and go into its directory.

$ git clone -b gh-pages https://github.com/caleorourke/exhibit.git
$ cd exhibit

Install Grunt and dev dependencies for Node.

$ sudo npm install -g grunt-cli
$ sudo npm install

Install Jekyll and other Ruby runtime dependencies.

$ sudo grunt install

exhibit leverages Grunt as a harness for installing Node and Ruby dependencies, in addition to serving the site locally.

Run any of these commands to initiate a task.

• $ grunt build
• $ grunt install
• $ grunt serve
• $ grunt test

1. Bundles and minifies *.less files to *.css using RECESS
2. Bundles and minifies *.js files using UglifyJS

1. Updates RubyGems
2. Runs gem install github-pages

1. Bundles and minifies *.less files to *.css using RECESS
2. Bundles and minifies *.js files using UglifyJS
3. Builds the site locally in the _site directory
4. Starts a local environment on http://localhost:4000
5. Regenerates a new _site directory whenever a file is modified (except .less and .js assets)

Serve mode lasts forever. It will not timeout after a period of non-usage. In order to stop it, press CTRL+C.

1. Builds the website locally in the _site directory
2. Spits out any errors found during the build process

Dependencies are updated often by their original authors. To install the most recent versions, run sudo npm update.

If this fails for whatever reason, run the following commands to delete the original node_modules directory and build a new one.

$ sudo rm -r node_modules
$ sudo npm install

Code and documentation licensed under the MIT license.