builds-static

builds-static

BUILDS static website which utilizes jekyll and bootstrap. To add content please merge and then file a pull request against your fork with the added content. An Admin will review it.

BUILDS Static Website

This is a static site for BUILDS based powered by Jekyll and Twitter Bootstrap.

Requirements

builds-static uses Jekyll which requires Ruby 1.9.3. To setup your ruby environment it is suggested that you use RVM.

  • Ruby 1.9.3
  • bundler $ gem install bundler
  • jekyll $ gem install jekyll

A Gemfile is included so you can run $ bundle install after you install bundler with $ gem install bundler.

Setting Up

In _config.yml there is a parameter called base, which needs to be set to the base url. For example, if I were to launch builds-static to "http://www.builds.cc" I would replace the current base parameter with:

base: http://www.builds.cc

Once this is done you can build the website with $ jekyll build and copy the contents of _site to the location the website will be hosted from.

If you want to do local testing you should set base: "". Then you can allow jekyll to serve the website locally with $ jekyll serve

Adding/Changing Content

This website uses jekyll and all new News/Blog posts go under the _posts folder. The current method of organizing the _posts folder is this: "category/YYYY-MM-DD-title.md" The only part which is required (by jekyll) is the YYYY-MM-DD part. The category part is optional and should correspond to the category in the YAML header. A standard yaml header can be found below:

---
layout: post
title:  "Full Title"
date:   2012-03-22 13:07:36
author: "Author Name"
categories: category
image_url: /assets/img/posts/category/filename/banner.jpg
tag: front
---

Note: A ruby program (nicknamed potion) is in the works for maintaining the directory structure, deleting posts, adding images to posts. potion will be released seperately and configured to the project with a _potion.yml file.

Sidebar links are included from _includes/sidebar-links.md it is just a markdown list which gets parsed when the jekyll site is compiled. To change the links just edit this file.