jekyll_patternbot 1.0.0 → 1.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.readme/patternbot-logo.png +0 -0
- data/.readme/screenshot.png +0 -0
- data/CHANGELOG.md +8 -0
- data/README.md +51 -19
- data/_plugins/jekyll_patternbot/parsers/css_font.rb +3 -3
- data/version.rb +1 -1
- metadata +3 -1
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 19b321a85c1263576bd674ec4316f974727a70eca0afad4f9227d7203983f2f7
|
4
|
+
data.tar.gz: 0c3d0bbee46dc930e2c838032f90f6cd66a1a4dfc57d9a9b6342a9af3d7b24e7
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: c54eab22186c0751071d5109fe41cd2d798151b132edbc37c310c5bfe051037083d09f9152f567c0a603a05c5108ce7d92ff40b0497c1815327e30f89ceb2f62
|
7
|
+
data.tar.gz: b966eda4d82780509ca6b2f9090e10188336b67fef3e4770780be32dfa5026a8b64c8877a2b7d191d5b378c10bf267f8a1ce6247859f623b17ac8dcee14f23fa
|
Binary file
|
Binary file
|
data/CHANGELOG.md
CHANGED
data/README.md
CHANGED
@@ -1,39 +1,71 @@
|
|
1
|
-
# Jekyll
|
1
|
+
# ![](.readme/patternbot-logo.png) Jekyll Patternbot
|
2
2
|
|
3
|
-
|
3
|
+
*Your pompous and persnickety patterning robot.*
|
4
4
|
|
5
|
-
|
5
|
+
---
|
6
6
|
|
7
|
-
|
7
|
+
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.)
|
8
8
|
|
9
|
-
|
9
|
+
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.
|
10
|
+
|
11
|
+
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.
|
12
|
+
|
13
|
+
**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.
|
14
|
+
|
15
|
+
---
|
16
|
+
|
17
|
+
## Installation & setup
|
18
|
+
|
19
|
+
**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/)**
|
20
|
+
|
21
|
+
After cloning your GitHub repo, press `Open in Terminal` from within GitHub Desktop.
|
22
|
+
|
23
|
+
### 1. Add a Gemfile
|
24
|
+
|
25
|
+
**Within Terminal type: `bundle init`**—this will create a new file in your folder named `Gemfile`
|
26
|
+
|
27
|
+
Edit your `Gemfile` and add these lines to the bottom:
|
10
28
|
|
11
29
|
```ruby
|
12
|
-
gem
|
30
|
+
gem "jekyll"
|
31
|
+
|
32
|
+
group :jekyll_plugins do
|
33
|
+
gem "jekyll_patternbot", :path => '/www/jekyll_patternbot/'
|
34
|
+
end
|
13
35
|
```
|
14
36
|
|
15
|
-
|
37
|
+
Then pop back over to **Terminal and run this command: `bundle install`**
|
38
|
+
|
39
|
+
### 2. Add a Ruby version
|
40
|
+
|
41
|
+
In your code editor create a new file named `.ruby-version`
|
16
42
|
|
17
|
-
|
43
|
+
Enter a current Ruby version number into the file, `2.5.3` is a recent version you can use.
|
18
44
|
|
19
|
-
|
45
|
+
```
|
46
|
+
2.5.3
|
47
|
+
```
|
20
48
|
|
21
|
-
|
49
|
+
### 3. Configure Jekyll
|
22
50
|
|
23
|
-
|
51
|
+
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.
|
24
52
|
|
25
|
-
|
53
|
+
In your code editor, **create a new file `_config.yml`**
|
26
54
|
|
27
|
-
|
55
|
+
Add this to your Jekyll `_config.yml` file:
|
28
56
|
|
29
|
-
|
57
|
+
```yml
|
58
|
+
permalink: pretty
|
59
|
+
|
60
|
+
theme: jekyll_patternbot
|
61
|
+
```
|
30
62
|
|
31
|
-
|
63
|
+
*The `permalink: pretty` isn’t necessary—but I always like to have nice permalinks in my websites.*
|
32
64
|
|
33
|
-
|
65
|
+
---
|
34
66
|
|
35
|
-
|
67
|
+
## Hosting Jekyll Patternbot
|
36
68
|
|
37
|
-
|
69
|
+
*Although GitHub supports Jekyll its list of allowed plugins is very strict—which means Patternbot cannot run on GitHub Pages.*
|
38
70
|
|
39
|
-
|
71
|
+
I suggest using [Netlify](https://www.netlify.com/) as a substitute to GitHub hosting for your projects that use Jekyll Patternbot.
|
@@ -115,9 +115,9 @@ module JekyllPatternbot
|
|
115
115
|
else
|
116
116
|
unless PatternbotCache.key?(font_url)
|
117
117
|
PatternbotCache[font_url] = self.parse_font_file(font_url)
|
118
|
-
PatternbotLogger.warn("Patternbot downloaded CSS for fonts from the remote URL: #{font_url}")
|
119
|
-
else
|
120
|
-
PatternbotLogger.info("Patternbot used a cached version of the font CSS originally located at: #{font_url}")
|
118
|
+
# PatternbotLogger.warn("Patternbot downloaded CSS for fonts from the remote URL: #{font_url}")
|
119
|
+
# else
|
120
|
+
# PatternbotLogger.info("Patternbot used a cached version of the font CSS originally located at: #{font_url}")
|
121
121
|
end
|
122
122
|
return self.parse_fonts data, PatternbotCache[font_url]
|
123
123
|
end
|
data/version.rb
CHANGED
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: jekyll_patternbot
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.0.
|
4
|
+
version: 1.0.1
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Thomas J Bradley
|
@@ -161,6 +161,8 @@ files:
|
|
161
161
|
- ".editorconfig"
|
162
162
|
- ".gitattributes"
|
163
163
|
- ".gitignore"
|
164
|
+
- ".readme/patternbot-logo.png"
|
165
|
+
- ".readme/screenshot.png"
|
164
166
|
- CHANGELOG.md
|
165
167
|
- Gemfile
|
166
168
|
- LICENSE.txt
|