jekyll_patternbot 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bcfd20d8d94f6dd76f47c9e9829e630f1ae0bb074e0f81ea16fa77225bd1fbb1
-  data.tar.gz: c2db021889a88be1dd9b2d796ee27e165c14068ae7b8e0a0bdbe33941eaa0179
+  metadata.gz: 19b321a85c1263576bd674ec4316f974727a70eca0afad4f9227d7203983f2f7
+  data.tar.gz: 0c3d0bbee46dc930e2c838032f90f6cd66a1a4dfc57d9a9b6342a9af3d7b24e7
 SHA512:
-  metadata.gz: 538e1cd1f064e074b15c3c9c15cc5affce324a0e8784248212e593619c152a4d2a32b216eb1cbecdba131fe38403bd0fc05ffcf8a674552d3089729256a332c0
-  data.tar.gz: 50d250ff5ff80f38c13440dfe17a50f5ffc43a3967daac98d1320c310631c15508d2f151101e1b77a3ab8079f21618ee811189d8437f43b0a8dcbde6ecb86f1c
+  metadata.gz: c54eab22186c0751071d5109fe41cd2d798151b132edbc37c310c5bfe051037083d09f9152f567c0a603a05c5108ce7d92ff40b0497c1815327e30f89ceb2f62
+  data.tar.gz: b966eda4d82780509ca6b2f9090e10188336b67fef3e4770780be32dfa5026a8b64c8877a2b7d191d5b378c10bf267f8a1ce6247859f623b17ac8dcee14f23fa

data/CHANGELOG.md

@@ -5,6 +5,14 @@ Jekyll Patternbot adheres to [Semantic Versioning](http://semver.org/).
 
 ---
 
+## [1.0.1] — 2019-01-16
+
+### Fixed
+
+- Attempting to fix a build error on Netlify.
+
+---
+
 ## [1.0.0] — 2019-01-16
 
 ### Added

data/README.md

@@ -1,39 +1,71 @@
-# Jekyll::Patternbot
+# ![](.readme/patternbot-logo.png) Jekyll Patternbot
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/jekyll/patternbot`. To experiment with that code, run `bin/console` for an interactive prompt.
+*Your pompous and persnickety patterning robot.*
 
-TODO: Delete this and the text above, and describe your gem
+---
 
-## Installation
+There are lots of fantastic tools for creating style guides and pattern libraries—but they all have a lot of embedded knowledge (command line, Gulp, Grunt, PHP, Handlebars, SASS, etc.)
 
-Add this line to your application's Gemfile:
+It’s just too much *stuff* for my students. I don’t want them to have to learn the tool, I want them to use a tool and get on with designing.
+
+My aim is not to replace the wonderful tools that exist, but simplify them into a very minimal package that can get the students familiarized with using style guides without having to learn all the extra stuff.
+
+**This is actually my second version of making a pattern library app: the first was a GUI.** But after working with students for a while & teaching & understanding their knowledge sphere, I’ve switched to a Jekyll plugin. It’s better at scaffolding their knowledge into future terms and opens up lots learning opportunities within the Jekyll ecosystem.
+
+---
+
+## Installation & setup
+
+**First make sure you have Ruby, RubyGems & Bundler installed. [☛ See this lesson for help with installing the tools.](https://learn-the-web.algonquindesign.ca/courses/web-dev-4/install-more-developer-tools/)**
+
+After cloning your GitHub repo, press `Open in Terminal` from within GitHub Desktop.
+
+### 1. Add a Gemfile
+
+**Within Terminal type: `bundle init`**—this will create a new file in your folder named `Gemfile`
+
+Edit your `Gemfile` and add these lines to the bottom:
 
 ```ruby
-gem 'jekyll_patternbot'
+gem "jekyll"
+
+group :jekyll_plugins do
+  gem "jekyll_patternbot", :path => '/www/jekyll_patternbot/'
+end
 ```
 
-And then execute:
+Then pop back over to **Terminal and run this command: `bundle install`**
+
+### 2. Add a Ruby version
+
+In your code editor create a new file named `.ruby-version`
 
-    $ bundle
+Enter a current Ruby version number into the file, `2.5.3` is a recent version you can use.
 
-Or install it yourself as:
+```
+2.5.3
+```
 
-    $ gem install jekyll_patternbot
+### 3. Configure Jekyll
 
-## Usage
+Finally we need to configure Jekyll to use Patternbot. It’s already using the Patternbot plugins, as defined in our `Gemfile` but we need to specify the Patternbot theme too.
 
-TODO: Write usage instructions here
+In your code editor, **create a new file `_config.yml`**
 
-## Development
+Add this to your Jekyll `_config.yml` file:
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```yml
+permalink: pretty
+
+theme: jekyll_patternbot
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+*The `permalink: pretty` isn’t necessary—but I always like to have nice permalinks in my websites.*
 
-## Contributing
+---
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/jekyll_patternbot.
+## Hosting Jekyll Patternbot
 
-## License
+*Although GitHub supports Jekyll its list of allowed plugins is very strict—which means Patternbot cannot run on GitHub Pages.*
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+I suggest using [Netlify](https://www.netlify.com/) as a substitute to GitHub hosting for your projects that use Jekyll Patternbot.

data/_plugins/jekyll_patternbot/parsers/css_font.rb

@@ -115,9 +115,9 @@ module JekyllPatternbot
       else
         unless PatternbotCache.key?(font_url)
           PatternbotCache[font_url] = self.parse_font_file(font_url)
-          PatternbotLogger.warn("Patternbot downloaded CSS for fonts from the remote URL: #{font_url}")
-        else
-          PatternbotLogger.info("Patternbot used a cached version of the font CSS originally located at: #{font_url}")
+          # PatternbotLogger.warn("Patternbot downloaded CSS for fonts from the remote URL: #{font_url}")
+        # else
+          # PatternbotLogger.info("Patternbot used a cached version of the font CSS originally located at: #{font_url}")
         end
         return self.parse_fonts data, PatternbotCache[font_url]
       end

data/version.rb

@@ -1,3 +1,3 @@
 module JekyllPatternbot
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_patternbot
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Thomas J Bradley
@@ -161,6 +161,8 @@ files:
 - ".editorconfig"
 - ".gitattributes"
 - ".gitignore"
+- ".readme/patternbot-logo.png"
+- ".readme/screenshot.png"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt