jekyll-bootstrap-sass 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4171989d4a750b1f22e5b0fc2544663d24aa0211
+  data.tar.gz: 9047c2eae360e6871a7edcd1fb8932eb100e724b
+SHA512:
+  metadata.gz: 6e5e9feb73261b5009193c9f5385ce77e76447c090f8ce24b3c7c6609b79c4e0ba52592d0cc0606a8af266c69eee7e8b50490a6c9cc10847baa4101723a5b5bc
+  data.tar.gz: cd9c805bb5032bff34e58b5ca2d1740bb4f8dbed91d6a10823201db2d564a21d08519301af9172d2882636b1cef82ea43fe4e33ad103ed6ce9f1e8166d7921fb

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.sass-cache
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,13 @@
+Style/AlignHash:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+
+Style/Documentation:
+  Enabled: false
+
+Lint/EndAlignment:
+  AlignWith: variable
+  AutoCorrect: true
+
+Style/FileName:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jekyll-bootstrap-sass.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Ben Balter
+
+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.

data/README.md

@@ -0,0 +1,57 @@
+# Jekyll Bootstrap Sass
+
+*A plugin to add the [Twitter Bootstrap](https://github.com/twbs/bootstrap) framework to your Jekyll site.*
+
+## Installation
+
+Add the following to your site's `Gemfile`:
+
+```ruby
+gem 'jekyll-bootstrap-sass'
+```
+
+And add the following to your site's `_config.yml` file:
+
+```yaml
+gems:
+  - jekyll-bootstrap-sass
+```
+
+## Usage
+
+Create a `.scss` file (e.g., `assets/style.scss`), with the following:
+
+```scss
+---
+---
+
+@import 'bootstrap';
+
+// (Your custom CSS Here)
+end
+```
+
+When your site is built, Jekyll will automatically add the Bootstrap framework before it renders your site's css. In the above example, the resulting file would be `assets/style.css` with Bootstrap's CSS followed by your own.
+
+## Assets
+
+By default, Jekyll Bootstrap SaSS will simply make the `@import 'bootstrap';` directive available to your custom stylesheets so that you can more easily include Bootstrap's CSS.
+
+If you would like to use Bootstrap's static assets (e.g., fonts, javascripts), you'll need to add the following to your site's `_config.yml`:
+
+```yml
+bootstrap:
+  assets: true
+```
+
+This will create `/assets/fonts/bootstrap` and `assets/javascripts/bootstrap` folders in the generated site, which you can include in your site's header as you would any other javascript file or font.
+
+If font's aren't loading properly, you may need to add the following before the `import` directive:
+
+```scss
+$icon-font-path: "{{ site.github.url }}/assets/fonts/bootstrap";
+```
+
+## Specifying the Bootstrap version
+
+Jekyll-bootstrap-sass relies on official [`bootstrap-sass` Ruby gem](https://github.com/twbs/bootstrap-sass). To specify the version of Bootstrap used, simply specify the `bootstrap-sass` gem version in your Gemfile.

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/jekyll-bootstrap-sass.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jekyll-bootstrap-sass/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'jekyll-bootstrap-sass'
+  spec.version       = Jekyll::BootstrapSass::VERSION
+  spec.authors       = ['Ben Balter']
+  spec.email         = ['ben.balter@github.com']
+
+  spec.summary       = 'A plugin to add Twitter Bootstrap to your Jekyll site'
+  spec.homepage      = 'https://github.com/benbalter/jekyll-bootstrap-sass'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |file|
+    file.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'jekyll', '>= 2.5'
+  spec.add_dependency 'bootstrap-sass', '~> 3.3'
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
+end

data/lib/bootstrap-sass/bootstrap-sass.rb

@@ -0,0 +1,8 @@
+module Bootstrap
+  class << self
+    # Monkey patch out a whole bunch of stuff we don't want
+    def load!
+      configure_sass
+    end
+  end
+end

data/lib/jekyll-bootstrap-sass.rb

@@ -0,0 +1,72 @@
+require 'jekyll-bootstrap-sass/version'
+require 'find'
+
+# Require bootstrap-sass to add bootstrap to SaSS's load path
+require 'bootstrap-sass'
+
+module Jekyll
+  module BootstrapSass
+    class Generator < Jekyll::Generator
+      def generate(site)
+        @site = site
+
+        # Add our static files to Jekyll's native static file support
+        @site.static_files.concat static_files if assets_enabled?
+      end
+
+      private
+
+      # Has the user explictly disabled asset support by adding
+      # The following to their `_config.yml` file:
+      #
+      # bootstrap
+      #   assets: false
+      def assets_enabled?
+        return false if @site.config['bootstrap'].nil?
+        @site.config['bootstrap']['assets'] == true
+      end
+
+      # Returns an array of Jekyll::StaticFile instances for each file
+      # in asset_files. Files are prefixed with an `assets/` directory
+      def static_files
+        source = File.dirname(assets_path)
+        asset_files.map do |file|
+          dir = File.dirname(file)
+          file_name = File.basename(file)
+          Jekyll::StaticFile.new @site, source, dir, file_name
+        end
+      end
+
+      # Return an array of paths to static files that should be included
+      # in the generated site.
+      #
+      # Note: All paths are relative to the assets_path directory
+      def asset_files
+        asset_files = []
+        Find.find(assets_path).each do |path|
+          next if File.directory?(path)
+          next if path.include?(stylesheets_path) || path.include?(images_path)
+          asset_files << path.sub(assets_path, 'assets')
+        end
+        asset_files
+      end
+
+      # Absolute path to bootstrap-sass's vendored static assets
+      def assets_path
+        @assets_path ||= Bootstrap.assets_path
+      end
+
+      # Absolute path to bootstrap-sass's images directory
+      # Which should be excluded because it's empty
+      def images_path
+        @imags_path ||= File.expand_path 'images/', assets_path
+      end
+
+      # Absolute path to bootstrap-sass's stylesheets directory
+      # Which should be excluded because it's processed by SaSS
+      def stylesheets_path
+        @stylesheets_path ||= File.expand_path 'stylesheets/', assets_path
+      end
+    end
+  end
+end

data/lib/jekyll-bootstrap-sass/version.rb

@@ -0,0 +1,5 @@
+module Jekyll
+  module BootstrapSass
+    VERSION = '0.1.0'
+  end
+end

data/script/bootstrap

@@ -0,0 +1,5 @@
+#!/bin/sh
+
+set -ex
+
+bundle install

data/script/cibuild

@@ -0,0 +1,7 @@
+#!/bin/sh
+
+set -ex
+
+bundle exec rake spec
+bundle exec rubocop
+bundle exec gem build jekyll-bootstrap-sass.gemspec

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-bootstrap-sass
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ben Balter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: bootstrap-sass
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- ben.balter@github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- jekyll-bootstrap-sass.gemspec
+- lib/bootstrap-sass/bootstrap-sass.rb
+- lib/jekyll-bootstrap-sass.rb
+- lib/jekyll-bootstrap-sass/version.rb
+- script/bootstrap
+- script/cibuild
+homepage: https://github.com/benbalter/jekyll-bootstrap-sass
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A plugin to add Twitter Bootstrap to your Jekyll site
+test_files: []