Skip to content

Commit

Permalink
Gem skeleton and README
Browse files Browse the repository at this point in the history
  • Loading branch information
adamlogic committed Nov 13, 2012
0 parents commit ab1f467
Show file tree
Hide file tree
Showing 8 changed files with 122 additions and 0 deletions.
17 changes: 17 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
*.gem
*.rbc
.bundle
.config
.yardoc
Gemfile.lock
InstalledFiles
_yardoc
coverage
doc/
lib/bundler/man
pkg
rdoc
spec/reports
test/tmp
test/version_tmp
tmp
4 changes: 4 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
source 'https://rubygems.org'

# Specify your gem's dependencies in middleman-gh-pages.gemspec
gemspec
22 changes: 22 additions & 0 deletions LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
Copyright (c) 2012 Adam McCrea

MIT License

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
43 changes: 43 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Middleman Github Pages

[Middleman](http://middlemanapp.com) makes creating static sites a joy, [Github
Pages](http://pages.github.com) hosts static sites for free, Middleman Github
Pages brings the two together. Middleman Github Pages is just a few rake tasks
that automate the process of deploying a Middleman site to Github Pages.

## Installation

Add this line to your Gemfile:

```shell
gem 'middleman-gh-pages'
```

You'll also need to require the gem in your Rakefile:

```ruby
require 'middleman-gh-pages'
```

## Usage

Middleman Github Pages provides the following rake tasks:

```shell
rake build # Compile all files into the build directory
rake publish # Build and publish to Github Pages
```

The only assumption is that you are deploying to a gh-pages branch in the same
remote as the source. `rake publish` will create this branch for you if it
doesn't exist.

Note that you cannot deploy your site if you have uncommitted changes.

## Contributing

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
1 change: 1 addition & 0 deletions Rakefile
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
require "bundler/gem_tasks"
9 changes: 9 additions & 0 deletions lib/middleman-gh-pages.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
require "middleman-gh-pages/version"

module Middleman
module Gh
module Pages
# Your code goes here...
end
end
end
7 changes: 7 additions & 0 deletions lib/middleman-gh-pages/version.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
module Middleman
module Gh
module Pages
VERSION = "0.0.1"
end
end
end
19 changes: 19 additions & 0 deletions middleman-gh-pages.gemspec
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# -*- encoding: utf-8 -*-
lib = File.expand_path('../lib', __FILE__)
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
require 'middleman-gh-pages/version'

Gem::Specification.new do |gem|
gem.name = "middleman-gh-pages"
gem.version = Middleman::Gh::Pages::VERSION
gem.authors = ["Adam McCrea"]
gem.email = ["[email protected]"]
gem.description = %q{TODO: Write a gem description}
gem.summary = %q{TODO: Write a gem summary}
gem.homepage = ""

gem.files = `git ls-files`.split($/)
gem.executables = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
gem.require_paths = ["lib"]
end

0 comments on commit ab1f467

Please sign in to comment.