Foundation

What is it?

This is the front page of foundation, a Jekyll based simplistic website with a few defaults and basic features, including:

• Aggregation of JS and CSS files,
• Static pages (like this front page) and a blog,
• Atom feed,
• Sitemap.xml and robots.txt,
• Clean & simple HTML5 markup,
• Nothing else (that’s the goal),

Why?

Using Github pages, and Jekyll to a larger extent, to build a wide range of website and web apps, we (as in Wiredcraft) needed a clean slate with a minimalistic boilerplate on which to build things.

Most of what was available out there was either bloated with features, missing important ones (proper feed or sitemap) or presented awkward markup. We also needed to include simple libraries like normalize.css that we systematically use in our projects.

How do I get started

1. Fork it on Github,

2. Read the README (or this page),

3. Change the config.yml to match your needs (take care at least of the url attribute: it’s set to localhost:4000 for local development but change it to either the actual full site url or the relative path from the root url),

4. Run Jekyll:

   1. Install Jekyll,
   2. Go at the root of the repository and run jekyll --server --auto,
   3. Go to http://localhost:4000,

5. Start adding content:

   1. Blog posts are files in the _posts folder,
   2. Static pages (.html) can be put at the root or any subfolder you create. After adding pages you’ll probably want to update the menu in _layouts/default.html and review the atom.xml,
   3. To add a CSS or JS file, simply drop it in _includes/css or _includes/js and update either all.css or all.js,