Skip to content

Commit b79824f

Browse files
author
Geoff Hing
committed
Document installing Jekyll using Bundler
This site gets built with Jekyll so show how to install Jekyll using Bundler. Add a Gemfile to follow the practice for installing Jekyll from the GitHub Pages docs (see https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll). That seems like a sensible option since this site is built using GitHub Pages. Addresses #68 #68
1 parent 94ce27c commit b79824f

File tree

3 files changed

+254
-1
lines changed

3 files changed

+254
-1
lines changed

‎Gemfile

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
source 'https://rubygems.org'
2+
gem 'github-pages', group: :jekyll_plugins

‎Gemfile.lock

+238
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,238 @@
1+
GEM
2+
remote: https://rubygems.org/
3+
specs:
4+
activesupport (4.2.9)
5+
i18n (~> 0.7)
6+
minitest (~> 5.1)
7+
thread_safe (~> 0.3, >= 0.3.4)
8+
tzinfo (~> 1.1)
9+
addressable (2.5.2)
10+
public_suffix (>= 2.0.2, < 4.0)
11+
coffee-script (2.4.1)
12+
coffee-script-source
13+
execjs
14+
coffee-script-source (1.11.1)
15+
colorator (1.1.0)
16+
commonmarker (0.17.7.1)
17+
ruby-enum (~> 0.5)
18+
concurrent-ruby (1.0.5)
19+
ethon (0.11.0)
20+
ffi (>= 1.3.0)
21+
execjs (2.7.0)
22+
faraday (0.13.1)
23+
multipart-post (>= 1.2, < 3)
24+
ffi (1.9.18)
25+
forwardable-extended (2.6.0)
26+
gemoji (3.0.0)
27+
github-pages (172)
28+
activesupport (= 4.2.9)
29+
github-pages-health-check (= 1.3.5)
30+
jekyll (= 3.6.2)
31+
jekyll-avatar (= 0.5.0)
32+
jekyll-coffeescript (= 1.0.2)
33+
jekyll-commonmark-ghpages (= 0.1.3)
34+
jekyll-default-layout (= 0.1.4)
35+
jekyll-feed (= 0.9.2)
36+
jekyll-gist (= 1.4.1)
37+
jekyll-github-metadata (= 2.9.3)
38+
jekyll-mentions (= 1.2.0)
39+
jekyll-optional-front-matter (= 0.3.0)
40+
jekyll-paginate (= 1.1.0)
41+
jekyll-readme-index (= 0.2.0)
42+
jekyll-redirect-from (= 0.12.1)
43+
jekyll-relative-links (= 0.5.2)
44+
jekyll-remote-theme (= 0.2.3)
45+
jekyll-sass-converter (= 1.5.0)
46+
jekyll-seo-tag (= 2.3.0)
47+
jekyll-sitemap (= 1.1.1)
48+
jekyll-swiss (= 0.4.0)
49+
jekyll-theme-architect (= 0.1.0)
50+
jekyll-theme-cayman (= 0.1.0)
51+
jekyll-theme-dinky (= 0.1.0)
52+
jekyll-theme-hacker (= 0.1.0)
53+
jekyll-theme-leap-day (= 0.1.0)
54+
jekyll-theme-merlot (= 0.1.0)
55+
jekyll-theme-midnight (= 0.1.0)
56+
jekyll-theme-minimal (= 0.1.0)
57+
jekyll-theme-modernist (= 0.1.0)
58+
jekyll-theme-primer (= 0.5.2)
59+
jekyll-theme-slate (= 0.1.0)
60+
jekyll-theme-tactile (= 0.1.0)
61+
jekyll-theme-time-machine (= 0.1.0)
62+
jekyll-titles-from-headings (= 0.5.0)
63+
jemoji (= 0.8.1)
64+
kramdown (= 1.14.0)
65+
liquid (= 4.0.0)
66+
listen (= 3.0.6)
67+
mercenary (~> 0.3)
68+
minima (= 2.1.1)
69+
rouge (= 2.2.1)
70+
terminal-table (~> 1.4)
71+
github-pages-health-check (1.3.5)
72+
addressable (~> 2.3)
73+
net-dns (~> 0.8)
74+
octokit (~> 4.0)
75+
public_suffix (~> 2.0)
76+
typhoeus (~> 0.7)
77+
html-pipeline (2.7.1)
78+
activesupport (>= 2)
79+
nokogiri (>= 1.4)
80+
i18n (0.9.1)
81+
concurrent-ruby (~> 1.0)
82+
jekyll (3.6.2)
83+
addressable (~> 2.4)
84+
colorator (~> 1.0)
85+
jekyll-sass-converter (~> 1.0)
86+
jekyll-watch (~> 1.1)
87+
kramdown (~> 1.14)
88+
liquid (~> 4.0)
89+
mercenary (~> 0.3.3)
90+
pathutil (~> 0.9)
91+
rouge (>= 1.7, < 3)
92+
safe_yaml (~> 1.0)
93+
jekyll-avatar (0.5.0)
94+
jekyll (~> 3.0)
95+
jekyll-coffeescript (1.0.2)
96+
coffee-script (~> 2.2)
97+
coffee-script-source (~> 1.11.1)
98+
jekyll-commonmark (1.1.0)
99+
commonmarker (~> 0.14)
100+
jekyll (>= 3.0, < 4.0)
101+
jekyll-commonmark-ghpages (0.1.3)
102+
commonmarker (~> 0.17.6)
103+
jekyll-commonmark (~> 1)
104+
rouge (~> 2)
105+
jekyll-default-layout (0.1.4)
106+
jekyll (~> 3.0)
107+
jekyll-feed (0.9.2)
108+
jekyll (~> 3.3)
109+
jekyll-gist (1.4.1)
110+
octokit (~> 4.2)
111+
jekyll-github-metadata (2.9.3)
112+
jekyll (~> 3.1)
113+
octokit (~> 4.0, != 4.4.0)
114+
jekyll-mentions (1.2.0)
115+
activesupport (~> 4.0)
116+
html-pipeline (~> 2.3)
117+
jekyll (~> 3.0)
118+
jekyll-optional-front-matter (0.3.0)
119+
jekyll (~> 3.0)
120+
jekyll-paginate (1.1.0)
121+
jekyll-readme-index (0.2.0)
122+
jekyll (~> 3.0)
123+
jekyll-redirect-from (0.12.1)
124+
jekyll (~> 3.3)
125+
jekyll-relative-links (0.5.2)
126+
jekyll (~> 3.3)
127+
jekyll-remote-theme (0.2.3)
128+
jekyll (~> 3.5)
129+
rubyzip (>= 1.2.1, < 3.0)
130+
typhoeus (>= 0.7, < 2.0)
131+
jekyll-sass-converter (1.5.0)
132+
sass (~> 3.4)
133+
jekyll-seo-tag (2.3.0)
134+
jekyll (~> 3.3)
135+
jekyll-sitemap (1.1.1)
136+
jekyll (~> 3.3)
137+
jekyll-swiss (0.4.0)
138+
jekyll-theme-architect (0.1.0)
139+
jekyll (~> 3.5)
140+
jekyll-seo-tag (~> 2.0)
141+
jekyll-theme-cayman (0.1.0)
142+
jekyll (~> 3.5)
143+
jekyll-seo-tag (~> 2.0)
144+
jekyll-theme-dinky (0.1.0)
145+
jekyll (~> 3.5)
146+
jekyll-seo-tag (~> 2.0)
147+
jekyll-theme-hacker (0.1.0)
148+
jekyll (~> 3.5)
149+
jekyll-seo-tag (~> 2.0)
150+
jekyll-theme-leap-day (0.1.0)
151+
jekyll (~> 3.5)
152+
jekyll-seo-tag (~> 2.0)
153+
jekyll-theme-merlot (0.1.0)
154+
jekyll (~> 3.5)
155+
jekyll-seo-tag (~> 2.0)
156+
jekyll-theme-midnight (0.1.0)
157+
jekyll (~> 3.5)
158+
jekyll-seo-tag (~> 2.0)
159+
jekyll-theme-minimal (0.1.0)
160+
jekyll (~> 3.5)
161+
jekyll-seo-tag (~> 2.0)
162+
jekyll-theme-modernist (0.1.0)
163+
jekyll (~> 3.5)
164+
jekyll-seo-tag (~> 2.0)
165+
jekyll-theme-primer (0.5.2)
166+
jekyll (~> 3.5)
167+
jekyll-github-metadata (~> 2.9)
168+
jekyll-seo-tag (~> 2.2)
169+
jekyll-theme-slate (0.1.0)
170+
jekyll (~> 3.5)
171+
jekyll-seo-tag (~> 2.0)
172+
jekyll-theme-tactile (0.1.0)
173+
jekyll (~> 3.5)
174+
jekyll-seo-tag (~> 2.0)
175+
jekyll-theme-time-machine (0.1.0)
176+
jekyll (~> 3.5)
177+
jekyll-seo-tag (~> 2.0)
178+
jekyll-titles-from-headings (0.5.0)
179+
jekyll (~> 3.3)
180+
jekyll-watch (1.5.1)
181+
listen (~> 3.0)
182+
jemoji (0.8.1)
183+
activesupport (~> 4.0, >= 4.2.9)
184+
gemoji (~> 3.0)
185+
html-pipeline (~> 2.2)
186+
jekyll (>= 3.0)
187+
kramdown (1.14.0)
188+
liquid (4.0.0)
189+
listen (3.0.6)
190+
rb-fsevent (>= 0.9.3)
191+
rb-inotify (>= 0.9.7)
192+
mercenary (0.3.6)
193+
mini_portile2 (2.3.0)
194+
minima (2.1.1)
195+
jekyll (~> 3.3)
196+
minitest (5.11.1)
197+
multipart-post (2.0.0)
198+
net-dns (0.8.0)
199+
nokogiri (1.8.1)
200+
mini_portile2 (~> 2.3.0)
201+
octokit (4.8.0)
202+
sawyer (~> 0.8.0, >= 0.5.3)
203+
pathutil (0.16.1)
204+
forwardable-extended (~> 2.6)
205+
public_suffix (2.0.5)
206+
rb-fsevent (0.10.2)
207+
rb-inotify (0.9.10)
208+
ffi (>= 0.5.0, < 2)
209+
rouge (2.2.1)
210+
ruby-enum (0.7.1)
211+
i18n
212+
rubyzip (1.2.1)
213+
safe_yaml (1.0.4)
214+
sass (3.5.4)
215+
sass-listen (~> 4.0.0)
216+
sass-listen (4.0.0)
217+
rb-fsevent (~> 0.9, >= 0.9.4)
218+
rb-inotify (~> 0.9, >= 0.9.7)
219+
sawyer (0.8.1)
220+
addressable (>= 2.3.5, < 2.6)
221+
faraday (~> 0.8, < 1.0)
222+
terminal-table (1.8.0)
223+
unicode-display_width (~> 1.1, >= 1.1.1)
224+
thread_safe (0.3.6)
225+
typhoeus (0.8.0)
226+
ethon (>= 0.8.0)
227+
tzinfo (1.2.4)
228+
thread_safe (~> 0.1)
229+
unicode-display_width (1.3.0)
230+
231+
PLATFORMS
232+
ruby
233+
234+
DEPENDENCIES
235+
github-pages
236+
237+
BUNDLED WITH
238+
1.16.1

‎README.md

+14-1
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,20 @@ Copyright 2013-17 NPR. All rights reserved. No part of these materials may be
55
nprapps.github.com
66
==================
77

8+
### Assumptions
9+
10+
* Ruby 2.1.0 or higher
11+
* [Bundler](http://bundler.io/). If you don't have this, you can install it with `gem install bundler`.
12+
813
### Getting Started
914

10-
Matt Stiles wrote a helpful post explaining [how to get set up](http://blog.apps.npr.org/2012/11/08/npr-news-apps-blog.html).
15+
This blog uses a static site generator called [Jekyll](https://jekyllrb.com/) to convert Markdown files into HTML.
16+
17+
To install Jekyll run:
18+
19+
```
20+
bundle install
21+
```
1122

1223
Once you have Jekyll installed, run this command to start up the development server and have it automatically regenerate files:
1324

@@ -21,6 +32,8 @@ You can see it in your browser here:
2132
http://localhost:4000
2233
```
2334

35+
Matt Stiles wrote a [helpful post](http://blog.apps.012/11/08/npr-news-apps-blog.html) that explains a bit more about how to Jekyll builds this site.
36+
2437
### Things To Know
2538

2639
* Pushing code to the repo will automatically publish any changes you've made. If you're not ready to publish yet, save your changes to a separate branch, and then merge it back to ```master``` when you're ready.

0 commit comments

Comments
 (0)