DockYard's ReefPoints Blog

Getting Setup

$ bundle install

Getting Up & Running

$ bundle exec middleman

# or run the Rake task

$ rake preview

Want to make your own post?

The GitHub web interface way

• Click here to be brought to the new post page
• Title your file following the pattern <date>-<title with dashes>.md, an example of this would be 2015-01-01-my-awesome-blog-post.md
• Add the following block to the beginning of the file, this block contains the meta data for the post:

---
layout: post
title: "My Awesome Blog post"
comments: true
social: true
author: Dan McClain
twitter: "_danmcclain"
github: danmcclain
summary: "A brief summary of your post"
published: true
tags: tags, separating each, with commas
---

• Place a new line underneath this meta data, and paste your content
• Scroll to the bottom, adding a commit message summary in the present tense Adds my awesome blog post
• Make this commit on a new branch by clicking the bottom radio button and giving the branch a name

• At this point, you will be brought to the pull request page, click the 'Create Pull Request' button

• Ask people to review your awesome new blog post

The command line way

• Pull down the latest

$ git pull origin master

• Make a new branch

$ git checkout -b YOURNAME-your-topic-name

• Done writing? Now you can submit your PR...

$ git push origin YOURNAME-your-topic-name

• Open a PR on Github using hub

$ brew install hub
$ hub pull-request -m "My awesome blog post" -b dockyard:master

• Or do it the old school way via the GitHub UI. Done getting feedback? Merge your branch into master.

• Now publish your post to Reefpoints!

$ git checkout master
$ git pull origin master
$ rake publish

Legal

DockYard, LLC © 2013

@dockyard

Licensed under the MIT license