Skip to content
A Jekyll plugin for developing pattern libraries & style guides that can be used to generate a Jekyll website.
CSS HTML Ruby JavaScript
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.readme Add basic setup to the readme file Jan 17, 2019
_data/locales Add extremely basic localization Jan 11, 2019
_includes Add the ability to categorize @Utility & @var tags Feb 8, 2019
_layouts Add the ability to customize the sidebar/nav background colour Feb 8, 2019
_patterns Add the ability to categorize @Utility & @var tags Feb 8, 2019
_plugins Revert a really bad code change related to the UTF-8 fix Feb 11, 2019
_sass Move to a Jekyll theme with integrated plugins & add basic functionality Jan 6, 2019
assets Add the ability to customize the sidebar/nav background colour Feb 8, 2019
.editorconfig Basic plugin implementation & proof of concept Dec 31, 2018
.gitattributes Merge branch 'master' of github.com:thomasjbradley/jekyll-patternbot Jan 6, 2019
.gitignore Add missing vendor libraries from within assets Jan 16, 2019
CHANGELOG.md Revert a really bad code change related to the UTF-8 fix Feb 11, 2019
Gemfile Force UTF-8 in certain situations to avoid conversion problems Feb 11, 2019
LICENSE.txt Basic plugin implementation & proof of concept Dec 31, 2018
README.md Fix some typos and correct grammar in the readme Jan 17, 2019
Rakefile Remove the RSpec stuff from the Rakefile Jan 15, 2019
_config.yml Add the ability to categorize @Utility & @var tags Feb 8, 2019
jekyll_patternbot.gemspec Force UTF-8 in certain situations to avoid conversion problems Feb 11, 2019
package.json Add the ability to document utility classes in theme.css Jan 12, 2019
version.rb Revert a really bad code change related to the UTF-8 fix Feb 11, 2019
yarn.lock Add common assets & patterns from old Patternbot Jan 6, 2019

README.md

Jekyll Patternbot

Your pompous and persnickety patterning robot.


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.)

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.

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:

gem "jekyll"

group :jekyll_plugins do
  gem "jekyll_patternbot"
end

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

Enter a current Ruby version number into the file, 2.5.3 is a recent version you can use.

2.5.3

3. Configure Jekyll

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.

In your code editor, create a new file _config.yml

Add this to your Jekyll _config.yml file:

permalink: pretty

theme: jekyll_patternbot

The permalink: pretty isn’t necessary—but I always like to have nice permalinks in my websites.


Hosting Jekyll Patternbot

Although GitHub supports Jekyll, its list of allowed plugins is very strict—which means Patternbot cannot run on GitHub Pages.

I suggest using Netlify as a substitute to GitHub hosting for your projects that use Jekyll Patternbot.

You can’t perform that action at this time.