Skip to content

shadygrove/martinbour.com

Repository files navigation

martinbour.com

This is the web site application for Martin Bour To view the live site visit:
http://www.martinbour.com
or
http://shadygrove.github.io/martinbour.com/

Info

Markdown
GitHub Pages
GitHub Pages Dependencies
Jekyll - Jekyll Variables
Bourbon - CSS Mixins for SASS
NEAT - grid framework for Bourbon
Bitters - html tag styling Pygments - syntax highlighting

About This Project

Who is this for?

It's really just for Martin so he can have a web page using GitHub pages and not pay for hosting

What is it?

It's just a static web application started with a GitHub pages template and running Jekyll

When was it created?

Started in April of 2015 when Martin decided to shut down his old programming blog that was running on BlogEngine.NET.

Why is this here?

It's really just for me. If you are looking at this, I can't think of any real reason why you would want to fork my code, but whatever.

Documentation

This site was setup using GitHub Pages.
The Jekyll platform is used for posts and pages
Posts are created using Markdown formatting
SASS is used to organize CSS

Notes from setup

Run site locally with Jekyll - “bundle exec jekyll serve”

Basic setup instructions - you can use a pre-built template and a “gh-pages” branch will automatically be identified and serve as a web page

Jekyll - a simple, static, blog-aware web framework built on Ruby-on-Rails Every GitHub page is run through Jekyll, so “Simply start committing Jekyll formatted files and you'll be using Jekyll in no time.”

Install Jekyll locally for development

Basics:
Install Ruby: I used RVM (Ruby Version Manager)
Install Bundler for Ruby “gem install bundler”

Add Jekyll to project

Create gem file “bundler init”
Add “gem 'github-pages” to the GemFile
Run “bundle install”:
I received an error here and had some problems that really held me up. I was using Ruby 1.9.3 and installed 2.2.2 using RVM (version mgr). This still did not work. In the end, I had to install xcode developer tools…
xcode-select --install which will create install dialog for XCode

To run site locally with Jekyll

bundle exec jekyll serve

Design and Layout (CSS)

Jekyll uses makes use of SASS, so I decided to use (Bourbon)[http://bourbon.io/] for some high-level CSS features, and (NEAT)[http://neat.bourbon.io/] for a grid framework.

How to Setup Bourbon

I have already generated Bourbon .scss in the "_sass" directory. These are the steps I took to do that...
Add gem 'bourbon to the Gemfile
Run bundle install - this will install the gem in your Ruby install
cd to the _sass directory, and
bourbon install - this will create a bourbon directory with all the necessary .scss files
Add import to "assets/css/styles.scss": @import 'bourbon/bourbon'

Jekyll configures SASS default directory to _sass, but I decided to be explicit and define it in the _config.yml anyway...
sass:
sass_dir: _sass

How to Setup Neat

Add gem 'neat' to the Gemfile
Run bundle install
Now we need to create the directory in _sass similar to how we did Bourbon...
cd to the _sass directory, and neat install
Import neat in the master .scss file at "assets/css/styles.scss"
@import "neat/neat"

Note: make sure you can still compile the project:
jekyll build from the root directory

Domain Name Setup

The most helpful page on setting this up was… Configuring A Record with DNS Provider Create CNAME file Setup DNS account Article on Go Daddy Setup

Final GoDaddy configuration looks this… A Names:
@ = 192.30.252.153
@ = 192.30.252.154
CNAME:
www = shadygrove.github.io

Other Notes:

Text Editor - Sublime Text 2 (supports simple projects)