Getting Started

Quick Start

Fork or clone the repo: git clone git@github.com:sparanoid/almace-scaffolding.git.
Install dependencies with Ruby gem bundler and Node.js package manager npm: bundle install && npm install.
Copy _config.init.yml to _config.yml as your default configuration file.
Run grunt serve.

So in short for geeks:

$ git clone git@github.com:sparanoid/almace-scaffolding.git
$ bundle install && npm install
$ cp _config.init.yml _config.yml
$ grunt serve

Download

Go to the GitHub repository for downloads, bug reports, and feature requests.

Upgrading

Upgrading templates is hard, it will be easy if you are’re a casual blogger and keep every template file untouched. Just copy and paste all template files in _assets, _includes, and _layouts. If you change the templates directly, you have to compare them side to side.

Customizing

All custom settings can be configured at _config.yml (a copy of _config.init.yml you just duplicated since your first setup), it’s well commented so you should really check it out.
Additional variables are stored in ./_app/_data/ directory. They can be accessed by Jekyll. (More info)
Customize your site’s look and fell by changing ./_app/assets/_less/custom.less.
Use your custom JavaScript snippets (Google Analytics, Typekit, etc.) in ./_app/_includes/js.html.
You should also change favicon.ico and apple-touch-icon.png to yours.
You can add Travis support for this project, simplly rename .travis.init.yml to .travis.yml.
Some tasks in Gruntfile.coffee are not used in this project, they’re copied from my own website, I’ll keep them untouched in case you need these.

Managing Media

Media files are located in /_app/assets/ and grouped by different formats:

_js/: JavaScript files, put all needed sctipts in this directoy will just work fine. All files in this directory will be automatically uglified and copied into js/. I don’t expect to have many scripts so no complex “vender”, “lib”, or other fancy structures used for this project.
_less/: LESS stylesheets, the leading underscore makes sure this directory is excluded from Jekyll generated site.
css/: CSS and its sourcemap files generated from LESS, it’s gitignored.
font/: Web fonts
img/: Image assets, images used by template, personally I don’t recommend put post images here, use a CDN instead.
svg/: The same as img/.

Advanced Usages

Tips

Not familer with Markdown? Try Markdown Cheatsheet.
You can use Jekyll’s built-in syntax highlighting, I’ve included a default theme for this project.
Tables and footnotes are also avaiables to use.

Other Notes

_config.yml is git ignored from .git/info/exclude file