jekyll-theme-csu-cs 0.1.4 → 0.1.5
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/LICENSE.txt +21 -21
- data/README.md +456 -456
- data/_includes/clone.html +10 -10
- data/_includes/disqus_comments.html +20 -20
- data/_includes/footer.html +71 -71
- data/_includes/google-analytics.html +11 -11
- data/_includes/grading/wholeGradesOnly.html +30 -30
- data/_includes/head.html +29 -29
- data/_includes/header.html +75 -75
- data/_includes/helpdesk.html +109 -109
- data/_includes/icon-github.html +1 -1
- data/_includes/icon-github.svg +1 -1
- data/_includes/icon-twitter.html +1 -1
- data/_includes/icon-twitter.svg +1 -1
- data/_includes/policies/cheating.html +66 -66
- data/_includes/policies/copyrighted.html +6 -6
- data/_includes/policies/daca.html +4 -4
- data/_includes/policies/diversityStatement.html +2 -2
- data/_includes/policies/honorPledge.html +11 -11
- data/_includes/policies/netiquette.html +2 -2
- data/_includes/policies/policiesAll.html +99 -99
- data/_includes/policies/religious.html +13 -13
- data/_includes/policies/thirdParty.html +4 -4
- data/_includes/policies/title9.html +17 -17
- data/_includes/policies/universalDesign.html +34 -34
- data/_includes/resources/canvasTech.html +17 -17
- data/_includes/resources/counseling.html +4 -4
- data/_includes/resources/eclipse.html +27 -27
- data/_includes/resources/intelliJ.html +9 -9
- data/_includes/resources/randomJavaLinks.html +9 -9
- data/_includes/resources/teams.html +7 -7
- data/_includes/resources/tilt.html +7 -7
- data/_includes/resources/university.html +11 -11
- data/_includes/social.html +15 -15
- data/_layouts/default.html +22 -22
- data/_layouts/home.html +12 -12
- data/_layouts/lab.html +2 -2
- data/_layouts/page.html +20 -20
- data/_layouts/post.html +32 -32
- data/_sass/csu-default.scss +46 -46
- data/_sass/parts/_base.scss +534 -534
- data/_sass/parts/_calendar.scss +137 -137
- data/_sass/parts/_cloneInclude.scss +16 -16
- data/_sass/parts/_contactcard.scss +78 -78
- data/_sass/parts/_labs.scss +46 -46
- data/_sass/parts/_syntax-highlighting.scss +81 -81
- data/assets/img/ducky.png +0 -0
- data/assets/img/signature-mobile.svg +1 -1
- data/assets/img/signature-oneline.svg +1 -1
- data/assets/img/signature-stacked.svg +1 -1
- data/assets/main.scss +7 -7
- data/assets/minima-social-icons.svg +38 -38
- metadata +27 -28
data/README.md
CHANGED
|
@@ -1,456 +1,456 @@
|
|
|
1
|
-
# jekyll-theme-csu-cs
|
|
2
|
-
|
|
3
|
-
The CSU-CS theme is based off the [Brand Style Guidelines](https://creativeservices.colostate.edu/brand-style-guide/).
|
|
4
|
-
It is meant for use of courses taught by the CS department at CSU, and students / faculty are also
|
|
5
|
-
free to use it. Please follow th CSU Branding Styl Guidelines and copy info.
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
## Installation
|
|
9
|
-
|
|
10
|
-
Add this line to your Jekyll site's `Gemfile`:
|
|
11
|
-
|
|
12
|
-
```ruby
|
|
13
|
-
gem "jekyll-theme-csu-cs"
|
|
14
|
-
```
|
|
15
|
-
|
|
16
|
-
And add this line to your Jekyll site's `_config.yml`:
|
|
17
|
-
|
|
18
|
-
```yaml
|
|
19
|
-
theme: jekyll-theme-csu-cs
|
|
20
|
-
```
|
|
21
|
-
|
|
22
|
-
And then execute:
|
|
23
|
-
|
|
24
|
-
$ bundle
|
|
25
|
-
|
|
26
|
-
Or install it yourself as:
|
|
27
|
-
|
|
28
|
-
$ gem install jekyll-theme-csu-cs
|
|
29
|
-
|
|
30
|
-
## Usage
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
### Quick List of Includes
|
|
34
|
-
|
|
35
|
-
Includes most courses should include:
|
|
36
|
-
|
|
37
|
-
* `resources/university.html` - includes tilt, counselling, and canvasTech with headers under a 'University Resources'
|
|
38
|
-
header. **Most courses should include this**.
|
|
39
|
-
* `policies/policiesAll.html` - lists policies related to CSU Principles of Community, includes all policies.
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
General Useful Includes:
|
|
43
|
-
* `resources/eclipse.html` - eclipse install information.
|
|
44
|
-
* `resources/intelliJ.html` - intelliJ install information including student account signup, and toolbox install.
|
|
45
|
-
* `resources/teams.html` - resources about Microsoft Teams, including install recommendations and links to ACNS.
|
|
46
|
-
* `resources/randomJavaLinks.html` - resources about random help / practice sites for java programming.
|
|
47
|
-
* `grading/wholeGradesOnly.html` - table with the 60,70,80,90 grade scale (no +/- options)
|
|
48
|
-
* `helpdesk.html` - MS Teams helpdesk instructions
|
|
49
|
-
* `clone.html` - Used for including a link to a git clone.
|
|
50
|
-
This include utilizes the following parameters, `url` and `text`. url is required, and will insert
|
|
51
|
-
the url of the git repository after >git clone. If text is included, a link will appear
|
|
52
|
-
at the bottom based on the text. For example:
|
|
53
|
-
```handlebars
|
|
54
|
-
{% include clone.html url="https://github.com/CSU-CS150/lectureExamples.git" text="Lecture Examples" %}
|
|
55
|
-
```
|
|
56
|
-
|
|
57
|
-
The following includes are all part of `resources/university.html`
|
|
58
|
-
* `resources/canvasTech.html` - information about technical support for canvas, usually not needed as already provided
|
|
59
|
-
in `resources/university.html`.
|
|
60
|
-
* `resources/counseling.html` - information about counseling services, usually not needed as already provided
|
|
61
|
-
in `resources/university.html`.
|
|
62
|
-
* `resources/tilt.html` - information about tilt and tutoring options for students, usually not needed as already provided
|
|
63
|
-
in `resources/university.html`.
|
|
64
|
-
|
|
65
|
-
The following includes are all part of `policies/policiesAll.html`
|
|
66
|
-
* `policies/cheating.html` - includes CMU cheating examples
|
|
67
|
-
* `policies/copyrighted.html` - copyrighted material disclaimer from CSU Online
|
|
68
|
-
* `policies/daca.html` - daca student resources
|
|
69
|
-
* `policies/diversityStatement.html` - CSU diversity statement
|
|
70
|
-
* `policies/honorPledge.html` - CSU honorPledge
|
|
71
|
-
* `policies/netiquette.html` - CSU netiquette
|
|
72
|
-
* `policies/religious.html` - CSU religious observance policies
|
|
73
|
-
* `policies/thirdParty.html` - CSU third party disclaimer on data collection
|
|
74
|
-
* `policies/title9.html` - CSU title 9 policies and resources for interpersonal violence
|
|
75
|
-
* `policies/universalDesign.html` - CSU universal design commitment
|
|
76
|
-
|
|
77
|
-
The following _includes you don't usually need to directly include, as the layouts already include them
|
|
78
|
-
|
|
79
|
-
* `google-analytics.html` - Inserts Google Analytics module (active only in production environment).
|
|
80
|
-
* `disqus_comments.html` - Code to markup disqus comment box.
|
|
81
|
-
* `footer.html` - Defines the site's footer section. Contains standard CS department links, and uses
|
|
82
|
-
the site description in the bottom right panel.
|
|
83
|
-
* `head.html` - Code-block that defines the `<head></head>` in *default* layout.
|
|
84
|
-
* `header.html` - Defines the site's main header section. By default, pages with a
|
|
85
|
-
defined `title` attribute will have links displayed here.
|
|
86
|
-
|
|
87
|
-
### Navigation Features
|
|
88
|
-
|
|
89
|
-
#### External Links in Top Menu
|
|
90
|
-
|
|
91
|
-
If you wish to have external links (for example canvas login) in the top menu bar, put each
|
|
92
|
-
link in the _config.yml file under `top-nav-external`. Each link
|
|
93
|
-
needs to have a `title` and `url`. For example:
|
|
94
|
-
|
|
95
|
-
```yaml
|
|
96
|
-
top-nav-external:
|
|
97
|
-
- title: Canvas
|
|
98
|
-
url: http://canvas.colostate.edu
|
|
99
|
-
```
|
|
100
|
-
|
|
101
|
-
#### no-nav
|
|
102
|
-
|
|
103
|
-
By including no-nav in your site data, the page will not show up in the navigation menu, even if
|
|
104
|
-
the page is a top-level page. For example:
|
|
105
|
-
|
|
106
|
-
```
|
|
107
|
-
---
|
|
108
|
-
layout: page
|
|
109
|
-
title: Virtual Help Desk Instructions
|
|
110
|
-
no-nav: true
|
|
111
|
-
permalink: help-desk/
|
|
112
|
-
---
|
|
113
|
-
```
|
|
114
|
-
|
|
115
|
-
#### Order
|
|
116
|
-
|
|
117
|
-
While jekyll defaults to alphanumeric order, by adding the `order` attribute. For example:
|
|
118
|
-
```
|
|
119
|
-
---
|
|
120
|
-
layout: page
|
|
121
|
-
title: Resources
|
|
122
|
-
order: 3
|
|
123
|
-
permalink: resources/
|
|
124
|
-
---
|
|
125
|
-
```
|
|
126
|
-
|
|
127
|
-
### HelpDesk Hours / Table
|
|
128
|
-
The theme comes with a dynamic table that adjust based on screen size. An example of
|
|
129
|
-
formatting of the table is as follows. The classes are essential.
|
|
130
|
-
|
|
131
|
-
```html
|
|
132
|
-
<h2>Helpdesk Times</h2>
|
|
133
|
-
<table id="calendar">
|
|
134
|
-
<caption>For Su2020 all helpdesk hours will be online. See: <a href="/~cs150/.Summer20/help-desk/">help desk instructions</a></caption>
|
|
135
|
-
<tr class="weekdays">
|
|
136
|
-
<th id="time" scope="col">Time (MDT)</th>
|
|
137
|
-
<th scope="col">Sunday</th>
|
|
138
|
-
<th scope="col">Monday</th>
|
|
139
|
-
<th scope="col">Tuesday</th>
|
|
140
|
-
<th scope="col">Wednesday</th>
|
|
141
|
-
<th scope="col">Thursday</th>
|
|
142
|
-
<th scope="col">Friday</th>
|
|
143
|
-
<th scope="col">Saturday</th>
|
|
144
|
-
</tr>
|
|
145
|
-
<tr>
|
|
146
|
-
<td class="time">
|
|
147
|
-
8:00 AM
|
|
148
|
-
</td>
|
|
149
|
-
<td>
|
|
150
|
-
|
|
151
|
-
</td>
|
|
152
|
-
<td>
|
|
153
|
-
|
|
154
|
-
</td>
|
|
155
|
-
<td>
|
|
156
|
-
|
|
157
|
-
</td>
|
|
158
|
-
<td>
|
|
159
|
-
|
|
160
|
-
</td>
|
|
161
|
-
<td>
|
|
162
|
-
|
|
163
|
-
</td>
|
|
164
|
-
<td>
|
|
165
|
-
|
|
166
|
-
</td>
|
|
167
|
-
<td>
|
|
168
|
-
|
|
169
|
-
</td>
|
|
170
|
-
</tr>
|
|
171
|
-
<tr>
|
|
172
|
-
<td class="time">
|
|
173
|
-
9:00 AM
|
|
174
|
-
</td>
|
|
175
|
-
<td>
|
|
176
|
-
|
|
177
|
-
</td>
|
|
178
|
-
<td>
|
|
179
|
-
|
|
180
|
-
</td>
|
|
181
|
-
<td>
|
|
182
|
-
|
|
183
|
-
</td>
|
|
184
|
-
<td>
|
|
185
|
-
|
|
186
|
-
</td>
|
|
187
|
-
<td>
|
|
188
|
-
|
|
189
|
-
</td>
|
|
190
|
-
<td>
|
|
191
|
-
|
|
192
|
-
</td>
|
|
193
|
-
<td>
|
|
194
|
-
|
|
195
|
-
</td>
|
|
196
|
-
</tr>
|
|
197
|
-
<tr>
|
|
198
|
-
<td class="time">
|
|
199
|
-
10:00 AM
|
|
200
|
-
</td>
|
|
201
|
-
<td>
|
|
202
|
-
|
|
203
|
-
</td>
|
|
204
|
-
<td>
|
|
205
|
-
|
|
206
|
-
</td>
|
|
207
|
-
<td>
|
|
208
|
-
|
|
209
|
-
</td>
|
|
210
|
-
<td>
|
|
211
|
-
|
|
212
|
-
</td>
|
|
213
|
-
<td>
|
|
214
|
-
|
|
215
|
-
</td>
|
|
216
|
-
<td>
|
|
217
|
-
|
|
218
|
-
</td>
|
|
219
|
-
<td>
|
|
220
|
-
|
|
221
|
-
</td>
|
|
222
|
-
</tr>
|
|
223
|
-
<tr>
|
|
224
|
-
<td class="time">
|
|
225
|
-
11:00 AM
|
|
226
|
-
</td>
|
|
227
|
-
<td>
|
|
228
|
-
|
|
229
|
-
</td>
|
|
230
|
-
<td>
|
|
231
|
-
|
|
232
|
-
</td>
|
|
233
|
-
<td>
|
|
234
|
-
|
|
235
|
-
</td>
|
|
236
|
-
<td>
|
|
237
|
-
|
|
238
|
-
</td>
|
|
239
|
-
<td>
|
|
240
|
-
|
|
241
|
-
</td>
|
|
242
|
-
<td>
|
|
243
|
-
|
|
244
|
-
</td>
|
|
245
|
-
<td>
|
|
246
|
-
|
|
247
|
-
</td>
|
|
248
|
-
</tr>
|
|
249
|
-
<tr>
|
|
250
|
-
<td class="time">
|
|
251
|
-
12:00 PM
|
|
252
|
-
</td>
|
|
253
|
-
<td>
|
|
254
|
-
|
|
255
|
-
</td>
|
|
256
|
-
<td>
|
|
257
|
-
|
|
258
|
-
</td>
|
|
259
|
-
<td class="">
|
|
260
|
-
</td>
|
|
261
|
-
<td class="">
|
|
262
|
-
</td>
|
|
263
|
-
<td class="">
|
|
264
|
-
</td>
|
|
265
|
-
<td>
|
|
266
|
-
|
|
267
|
-
</td>
|
|
268
|
-
<td>
|
|
269
|
-
|
|
270
|
-
</td>
|
|
271
|
-
</tr>
|
|
272
|
-
<tr>
|
|
273
|
-
<td class="time">
|
|
274
|
-
1:00 PM
|
|
275
|
-
</td>
|
|
276
|
-
<td>
|
|
277
|
-
|
|
278
|
-
</td>
|
|
279
|
-
<td class="">
|
|
280
|
-
</td>
|
|
281
|
-
<td class="">
|
|
282
|
-
</td>
|
|
283
|
-
<td class="">
|
|
284
|
-
</td>
|
|
285
|
-
<td class="">
|
|
286
|
-
</td>
|
|
287
|
-
<td>
|
|
288
|
-
|
|
289
|
-
</td>
|
|
290
|
-
<td>
|
|
291
|
-
|
|
292
|
-
</td>
|
|
293
|
-
</tr>
|
|
294
|
-
<tr>
|
|
295
|
-
<td class="time">
|
|
296
|
-
2:00 PM
|
|
297
|
-
</td>
|
|
298
|
-
<td>
|
|
299
|
-
|
|
300
|
-
</td>
|
|
301
|
-
<td class="">
|
|
302
|
-
</td>
|
|
303
|
-
<td class="">
|
|
304
|
-
</td>
|
|
305
|
-
<td class="">
|
|
306
|
-
</td>
|
|
307
|
-
<td class="">
|
|
308
|
-
</td>
|
|
309
|
-
<td>
|
|
310
|
-
|
|
311
|
-
</td>
|
|
312
|
-
<td>
|
|
313
|
-
|
|
314
|
-
</td>
|
|
315
|
-
</tr>
|
|
316
|
-
<tr>
|
|
317
|
-
<td class="time">
|
|
318
|
-
3:00 PM
|
|
319
|
-
</td>
|
|
320
|
-
<td>
|
|
321
|
-
|
|
322
|
-
</td>
|
|
323
|
-
<td class="open">
|
|
324
|
-
<span class="day">M</span>
|
|
325
|
-
<span class="shift"> <a href="/~cs150/.Summer20/help-desk/">MS Teams</a></span>
|
|
326
|
-
</td>
|
|
327
|
-
<td class="open">
|
|
328
|
-
<span class="day">T</span>
|
|
329
|
-
<span class="shift"><a href="/~cs150/.Summer20/help-desk/">MS Teams</a></span>
|
|
330
|
-
</td>
|
|
331
|
-
<td class="open">
|
|
332
|
-
<span class="day">W</span>
|
|
333
|
-
<span class="shift"><a href="/~cs150/.Summer20/help-desk/">MS Teams</a></span>
|
|
334
|
-
</td>
|
|
335
|
-
<td class="open">
|
|
336
|
-
<span class="day">Th</span>
|
|
337
|
-
<span class="shift"><a href="/~cs150/.Summer20/help-desk/">MS Teams</a></span>
|
|
338
|
-
</td>
|
|
339
|
-
<td>
|
|
340
|
-
|
|
341
|
-
</td>
|
|
342
|
-
<td>
|
|
343
|
-
|
|
344
|
-
</td>
|
|
345
|
-
</tr>
|
|
346
|
-
<tr>
|
|
347
|
-
<td class="time">
|
|
348
|
-
4:00 PM
|
|
349
|
-
</td>
|
|
350
|
-
<td>
|
|
351
|
-
|
|
352
|
-
</td>
|
|
353
|
-
<td class="open">
|
|
354
|
-
<span class="day">M</span>
|
|
355
|
-
<span class="shift"><a href="/~cs150/.Summer20/help-desk/">MS Teams</a></span>
|
|
356
|
-
</td>
|
|
357
|
-
<td class="open">
|
|
358
|
-
<span class="day">T</span>
|
|
359
|
-
<span class="shift"><a href="/~cs150/.Summer20/help-desk/">MS Teams</a></span>
|
|
360
|
-
</td>
|
|
361
|
-
<td class="open">
|
|
362
|
-
<span class="day">W</span>
|
|
363
|
-
<span class="shift"><a href="/~cs150/.Summer20/help-desk/">MS Teams</a></span>
|
|
364
|
-
</td>
|
|
365
|
-
<td class="open">
|
|
366
|
-
<span class="day">Th</span>
|
|
367
|
-
<span class="shift"><a href="/~cs150/.Summer20/help-desk/">MS Teams</a></span>
|
|
368
|
-
</td>
|
|
369
|
-
<td>
|
|
370
|
-
|
|
371
|
-
</td>
|
|
372
|
-
<td>
|
|
373
|
-
|
|
374
|
-
</td>
|
|
375
|
-
</tr>
|
|
376
|
-
<tr>
|
|
377
|
-
<td class="time">
|
|
378
|
-
5:00 PM
|
|
379
|
-
</td>
|
|
380
|
-
<td>
|
|
381
|
-
|
|
382
|
-
</td>
|
|
383
|
-
<td>
|
|
384
|
-
|
|
385
|
-
</td>
|
|
386
|
-
<td>
|
|
387
|
-
|
|
388
|
-
</td>
|
|
389
|
-
<td>
|
|
390
|
-
|
|
391
|
-
</td>
|
|
392
|
-
<td>
|
|
393
|
-
|
|
394
|
-
</td>
|
|
395
|
-
<td>
|
|
396
|
-
|
|
397
|
-
</td>
|
|
398
|
-
<td>
|
|
399
|
-
|
|
400
|
-
</td>
|
|
401
|
-
</tr>
|
|
402
|
-
</table>
|
|
403
|
-
```
|
|
404
|
-
|
|
405
|
-
### Enabling Google Analytics
|
|
406
|
-
To enable Google Analytics, add the following lines to your Jekyll site:
|
|
407
|
-
|
|
408
|
-
```
|
|
409
|
-
google_analytics: UA-NNNNNNNN-N
|
|
410
|
-
```
|
|
411
|
-
Google Analytics will only appear in production, i.e., JEKYLL_ENV=production
|
|
412
|
-
|
|
413
|
-
### Enabling Excerpts on the Home Page
|
|
414
|
-
To display post-excerpts on the Home Page, simply add the following to your _config.yml:
|
|
415
|
-
```
|
|
416
|
-
show_excerpts: true
|
|
417
|
-
```
|
|
418
|
-
|
|
419
|
-
### Plugins
|
|
420
|
-
csu-cs comes with the following plugins:
|
|
421
|
-
|
|
422
|
-
* [`jekyll-seo-tag`](https://github.com/jekyll/jekyll-seo-tag) plugin preinstalled to make sure
|
|
423
|
-
your website gets the most useful meta tags.
|
|
424
|
-
See [usage](https://github.com/jekyll/jekyll-seo-tag#usage) to know how to set it up.
|
|
425
|
-
|
|
426
|
-
* [`jekyll-feed`](https://github.com/jekyll/jekyll-feed) - A Jekyll plugin to generate an Atom (RSS-like)
|
|
427
|
-
feed of your Jekyll posts
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
## Contributing
|
|
431
|
-
|
|
432
|
-
Bug reports and pull requests are welcome on GitHub at
|
|
433
|
-
https://github.com/Dept-of-Computer-Science/jekyll-theme-csu-cs.
|
|
434
|
-
This project is intended to be a safe, welcoming space for collaboration, and contributors are expected
|
|
435
|
-
to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
|
|
436
|
-
|
|
437
|
-
## Development
|
|
438
|
-
|
|
439
|
-
To set up your environment to develop this theme, run `bundle install`.
|
|
440
|
-
|
|
441
|
-
Your theme is setup just like a normal Jekyll site! To test your theme, run `bundle exec jekyll serve`
|
|
442
|
-
and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme.
|
|
443
|
-
Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications
|
|
444
|
-
to your theme and to your content, your site will regenerate and you should see the changes in the browser
|
|
445
|
-
after a refresh, just like normal.
|
|
446
|
-
|
|
447
|
-
## License
|
|
448
|
-
|
|
449
|
-
The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
|
|
450
|
-
|
|
451
|
-
## Acknowledgements
|
|
452
|
-
|
|
453
|
-
* jekyll-minima - The style sheet, and svg icons are based off their original theme. Analytics comes from minima theme.
|
|
454
|
-
* jekyll-feed - Included as part of the gem bundle
|
|
455
|
-
* jekyll-seo - Included as part of the gem bundle
|
|
456
|
-
|
|
1
|
+
# jekyll-theme-csu-cs
|
|
2
|
+
|
|
3
|
+
The CSU-CS theme is based off the [Brand Style Guidelines](https://creativeservices.colostate.edu/brand-style-guide/).
|
|
4
|
+
It is meant for use of courses taught by the CS department at CSU, and students / faculty are also
|
|
5
|
+
free to use it. Please follow th CSU Branding Styl Guidelines and copy info.
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
## Installation
|
|
9
|
+
|
|
10
|
+
Add this line to your Jekyll site's `Gemfile`:
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
gem "jekyll-theme-csu-cs"
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
And add this line to your Jekyll site's `_config.yml`:
|
|
17
|
+
|
|
18
|
+
```yaml
|
|
19
|
+
theme: jekyll-theme-csu-cs
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
And then execute:
|
|
23
|
+
|
|
24
|
+
$ bundle
|
|
25
|
+
|
|
26
|
+
Or install it yourself as:
|
|
27
|
+
|
|
28
|
+
$ gem install jekyll-theme-csu-cs
|
|
29
|
+
|
|
30
|
+
## Usage
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
### Quick List of Includes
|
|
34
|
+
|
|
35
|
+
Includes most courses should include:
|
|
36
|
+
|
|
37
|
+
* `resources/university.html` - includes tilt, counselling, and canvasTech with headers under a 'University Resources'
|
|
38
|
+
header. **Most courses should include this**.
|
|
39
|
+
* `policies/policiesAll.html` - lists policies related to CSU Principles of Community, includes all policies.
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
General Useful Includes:
|
|
43
|
+
* `resources/eclipse.html` - eclipse install information.
|
|
44
|
+
* `resources/intelliJ.html` - intelliJ install information including student account signup, and toolbox install.
|
|
45
|
+
* `resources/teams.html` - resources about Microsoft Teams, including install recommendations and links to ACNS.
|
|
46
|
+
* `resources/randomJavaLinks.html` - resources about random help / practice sites for java programming.
|
|
47
|
+
* `grading/wholeGradesOnly.html` - table with the 60,70,80,90 grade scale (no +/- options)
|
|
48
|
+
* `helpdesk.html` - MS Teams helpdesk instructions
|
|
49
|
+
* `clone.html` - Used for including a link to a git clone.
|
|
50
|
+
This include utilizes the following parameters, `url` and `text`. url is required, and will insert
|
|
51
|
+
the url of the git repository after >git clone. If text is included, a link will appear
|
|
52
|
+
at the bottom based on the text. For example:
|
|
53
|
+
```handlebars
|
|
54
|
+
{% include clone.html url="https://github.com/CSU-CS150/lectureExamples.git" text="Lecture Examples" %}
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
The following includes are all part of `resources/university.html`
|
|
58
|
+
* `resources/canvasTech.html` - information about technical support for canvas, usually not needed as already provided
|
|
59
|
+
in `resources/university.html`.
|
|
60
|
+
* `resources/counseling.html` - information about counseling services, usually not needed as already provided
|
|
61
|
+
in `resources/university.html`.
|
|
62
|
+
* `resources/tilt.html` - information about tilt and tutoring options for students, usually not needed as already provided
|
|
63
|
+
in `resources/university.html`.
|
|
64
|
+
|
|
65
|
+
The following includes are all part of `policies/policiesAll.html`
|
|
66
|
+
* `policies/cheating.html` - includes CMU cheating examples
|
|
67
|
+
* `policies/copyrighted.html` - copyrighted material disclaimer from CSU Online
|
|
68
|
+
* `policies/daca.html` - daca student resources
|
|
69
|
+
* `policies/diversityStatement.html` - CSU diversity statement
|
|
70
|
+
* `policies/honorPledge.html` - CSU honorPledge
|
|
71
|
+
* `policies/netiquette.html` - CSU netiquette
|
|
72
|
+
* `policies/religious.html` - CSU religious observance policies
|
|
73
|
+
* `policies/thirdParty.html` - CSU third party disclaimer on data collection
|
|
74
|
+
* `policies/title9.html` - CSU title 9 policies and resources for interpersonal violence
|
|
75
|
+
* `policies/universalDesign.html` - CSU universal design commitment
|
|
76
|
+
|
|
77
|
+
The following _includes you don't usually need to directly include, as the layouts already include them
|
|
78
|
+
|
|
79
|
+
* `google-analytics.html` - Inserts Google Analytics module (active only in production environment).
|
|
80
|
+
* `disqus_comments.html` - Code to markup disqus comment box.
|
|
81
|
+
* `footer.html` - Defines the site's footer section. Contains standard CS department links, and uses
|
|
82
|
+
the site description in the bottom right panel.
|
|
83
|
+
* `head.html` - Code-block that defines the `<head></head>` in *default* layout.
|
|
84
|
+
* `header.html` - Defines the site's main header section. By default, pages with a
|
|
85
|
+
defined `title` attribute will have links displayed here.
|
|
86
|
+
|
|
87
|
+
### Navigation Features
|
|
88
|
+
|
|
89
|
+
#### External Links in Top Menu
|
|
90
|
+
|
|
91
|
+
If you wish to have external links (for example canvas login) in the top menu bar, put each
|
|
92
|
+
link in the _config.yml file under `top-nav-external`. Each link
|
|
93
|
+
needs to have a `title` and `url`. For example:
|
|
94
|
+
|
|
95
|
+
```yaml
|
|
96
|
+
top-nav-external:
|
|
97
|
+
- title: Canvas
|
|
98
|
+
url: http://canvas.colostate.edu
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
#### no-nav
|
|
102
|
+
|
|
103
|
+
By including no-nav in your site data, the page will not show up in the navigation menu, even if
|
|
104
|
+
the page is a top-level page. For example:
|
|
105
|
+
|
|
106
|
+
```
|
|
107
|
+
---
|
|
108
|
+
layout: page
|
|
109
|
+
title: Virtual Help Desk Instructions
|
|
110
|
+
no-nav: true
|
|
111
|
+
permalink: help-desk/
|
|
112
|
+
---
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
#### Order
|
|
116
|
+
|
|
117
|
+
While jekyll defaults to alphanumeric order, by adding the `order` attribute. For example:
|
|
118
|
+
```
|
|
119
|
+
---
|
|
120
|
+
layout: page
|
|
121
|
+
title: Resources
|
|
122
|
+
order: 3
|
|
123
|
+
permalink: resources/
|
|
124
|
+
---
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
### HelpDesk Hours / Table
|
|
128
|
+
The theme comes with a dynamic table that adjust based on screen size. An example of
|
|
129
|
+
formatting of the table is as follows. The classes are essential.
|
|
130
|
+
|
|
131
|
+
```html
|
|
132
|
+
<h2>Helpdesk Times</h2>
|
|
133
|
+
<table id="calendar">
|
|
134
|
+
<caption>For Su2020 all helpdesk hours will be online. See: <a href="/~cs150/.Summer20/help-desk/">help desk instructions</a></caption>
|
|
135
|
+
<tr class="weekdays">
|
|
136
|
+
<th id="time" scope="col">Time (MDT)</th>
|
|
137
|
+
<th scope="col">Sunday</th>
|
|
138
|
+
<th scope="col">Monday</th>
|
|
139
|
+
<th scope="col">Tuesday</th>
|
|
140
|
+
<th scope="col">Wednesday</th>
|
|
141
|
+
<th scope="col">Thursday</th>
|
|
142
|
+
<th scope="col">Friday</th>
|
|
143
|
+
<th scope="col">Saturday</th>
|
|
144
|
+
</tr>
|
|
145
|
+
<tr>
|
|
146
|
+
<td class="time">
|
|
147
|
+
8:00 AM
|
|
148
|
+
</td>
|
|
149
|
+
<td>
|
|
150
|
+
|
|
151
|
+
</td>
|
|
152
|
+
<td>
|
|
153
|
+
|
|
154
|
+
</td>
|
|
155
|
+
<td>
|
|
156
|
+
|
|
157
|
+
</td>
|
|
158
|
+
<td>
|
|
159
|
+
|
|
160
|
+
</td>
|
|
161
|
+
<td>
|
|
162
|
+
|
|
163
|
+
</td>
|
|
164
|
+
<td>
|
|
165
|
+
|
|
166
|
+
</td>
|
|
167
|
+
<td>
|
|
168
|
+
|
|
169
|
+
</td>
|
|
170
|
+
</tr>
|
|
171
|
+
<tr>
|
|
172
|
+
<td class="time">
|
|
173
|
+
9:00 AM
|
|
174
|
+
</td>
|
|
175
|
+
<td>
|
|
176
|
+
|
|
177
|
+
</td>
|
|
178
|
+
<td>
|
|
179
|
+
|
|
180
|
+
</td>
|
|
181
|
+
<td>
|
|
182
|
+
|
|
183
|
+
</td>
|
|
184
|
+
<td>
|
|
185
|
+
|
|
186
|
+
</td>
|
|
187
|
+
<td>
|
|
188
|
+
|
|
189
|
+
</td>
|
|
190
|
+
<td>
|
|
191
|
+
|
|
192
|
+
</td>
|
|
193
|
+
<td>
|
|
194
|
+
|
|
195
|
+
</td>
|
|
196
|
+
</tr>
|
|
197
|
+
<tr>
|
|
198
|
+
<td class="time">
|
|
199
|
+
10:00 AM
|
|
200
|
+
</td>
|
|
201
|
+
<td>
|
|
202
|
+
|
|
203
|
+
</td>
|
|
204
|
+
<td>
|
|
205
|
+
|
|
206
|
+
</td>
|
|
207
|
+
<td>
|
|
208
|
+
|
|
209
|
+
</td>
|
|
210
|
+
<td>
|
|
211
|
+
|
|
212
|
+
</td>
|
|
213
|
+
<td>
|
|
214
|
+
|
|
215
|
+
</td>
|
|
216
|
+
<td>
|
|
217
|
+
|
|
218
|
+
</td>
|
|
219
|
+
<td>
|
|
220
|
+
|
|
221
|
+
</td>
|
|
222
|
+
</tr>
|
|
223
|
+
<tr>
|
|
224
|
+
<td class="time">
|
|
225
|
+
11:00 AM
|
|
226
|
+
</td>
|
|
227
|
+
<td>
|
|
228
|
+
|
|
229
|
+
</td>
|
|
230
|
+
<td>
|
|
231
|
+
|
|
232
|
+
</td>
|
|
233
|
+
<td>
|
|
234
|
+
|
|
235
|
+
</td>
|
|
236
|
+
<td>
|
|
237
|
+
|
|
238
|
+
</td>
|
|
239
|
+
<td>
|
|
240
|
+
|
|
241
|
+
</td>
|
|
242
|
+
<td>
|
|
243
|
+
|
|
244
|
+
</td>
|
|
245
|
+
<td>
|
|
246
|
+
|
|
247
|
+
</td>
|
|
248
|
+
</tr>
|
|
249
|
+
<tr>
|
|
250
|
+
<td class="time">
|
|
251
|
+
12:00 PM
|
|
252
|
+
</td>
|
|
253
|
+
<td>
|
|
254
|
+
|
|
255
|
+
</td>
|
|
256
|
+
<td>
|
|
257
|
+
|
|
258
|
+
</td>
|
|
259
|
+
<td class="">
|
|
260
|
+
</td>
|
|
261
|
+
<td class="">
|
|
262
|
+
</td>
|
|
263
|
+
<td class="">
|
|
264
|
+
</td>
|
|
265
|
+
<td>
|
|
266
|
+
|
|
267
|
+
</td>
|
|
268
|
+
<td>
|
|
269
|
+
|
|
270
|
+
</td>
|
|
271
|
+
</tr>
|
|
272
|
+
<tr>
|
|
273
|
+
<td class="time">
|
|
274
|
+
1:00 PM
|
|
275
|
+
</td>
|
|
276
|
+
<td>
|
|
277
|
+
|
|
278
|
+
</td>
|
|
279
|
+
<td class="">
|
|
280
|
+
</td>
|
|
281
|
+
<td class="">
|
|
282
|
+
</td>
|
|
283
|
+
<td class="">
|
|
284
|
+
</td>
|
|
285
|
+
<td class="">
|
|
286
|
+
</td>
|
|
287
|
+
<td>
|
|
288
|
+
|
|
289
|
+
</td>
|
|
290
|
+
<td>
|
|
291
|
+
|
|
292
|
+
</td>
|
|
293
|
+
</tr>
|
|
294
|
+
<tr>
|
|
295
|
+
<td class="time">
|
|
296
|
+
2:00 PM
|
|
297
|
+
</td>
|
|
298
|
+
<td>
|
|
299
|
+
|
|
300
|
+
</td>
|
|
301
|
+
<td class="">
|
|
302
|
+
</td>
|
|
303
|
+
<td class="">
|
|
304
|
+
</td>
|
|
305
|
+
<td class="">
|
|
306
|
+
</td>
|
|
307
|
+
<td class="">
|
|
308
|
+
</td>
|
|
309
|
+
<td>
|
|
310
|
+
|
|
311
|
+
</td>
|
|
312
|
+
<td>
|
|
313
|
+
|
|
314
|
+
</td>
|
|
315
|
+
</tr>
|
|
316
|
+
<tr>
|
|
317
|
+
<td class="time">
|
|
318
|
+
3:00 PM
|
|
319
|
+
</td>
|
|
320
|
+
<td>
|
|
321
|
+
|
|
322
|
+
</td>
|
|
323
|
+
<td class="open">
|
|
324
|
+
<span class="day">M</span>
|
|
325
|
+
<span class="shift"> <a href="/~cs150/.Summer20/help-desk/">MS Teams</a></span>
|
|
326
|
+
</td>
|
|
327
|
+
<td class="open">
|
|
328
|
+
<span class="day">T</span>
|
|
329
|
+
<span class="shift"><a href="/~cs150/.Summer20/help-desk/">MS Teams</a></span>
|
|
330
|
+
</td>
|
|
331
|
+
<td class="open">
|
|
332
|
+
<span class="day">W</span>
|
|
333
|
+
<span class="shift"><a href="/~cs150/.Summer20/help-desk/">MS Teams</a></span>
|
|
334
|
+
</td>
|
|
335
|
+
<td class="open">
|
|
336
|
+
<span class="day">Th</span>
|
|
337
|
+
<span class="shift"><a href="/~cs150/.Summer20/help-desk/">MS Teams</a></span>
|
|
338
|
+
</td>
|
|
339
|
+
<td>
|
|
340
|
+
|
|
341
|
+
</td>
|
|
342
|
+
<td>
|
|
343
|
+
|
|
344
|
+
</td>
|
|
345
|
+
</tr>
|
|
346
|
+
<tr>
|
|
347
|
+
<td class="time">
|
|
348
|
+
4:00 PM
|
|
349
|
+
</td>
|
|
350
|
+
<td>
|
|
351
|
+
|
|
352
|
+
</td>
|
|
353
|
+
<td class="open">
|
|
354
|
+
<span class="day">M</span>
|
|
355
|
+
<span class="shift"><a href="/~cs150/.Summer20/help-desk/">MS Teams</a></span>
|
|
356
|
+
</td>
|
|
357
|
+
<td class="open">
|
|
358
|
+
<span class="day">T</span>
|
|
359
|
+
<span class="shift"><a href="/~cs150/.Summer20/help-desk/">MS Teams</a></span>
|
|
360
|
+
</td>
|
|
361
|
+
<td class="open">
|
|
362
|
+
<span class="day">W</span>
|
|
363
|
+
<span class="shift"><a href="/~cs150/.Summer20/help-desk/">MS Teams</a></span>
|
|
364
|
+
</td>
|
|
365
|
+
<td class="open">
|
|
366
|
+
<span class="day">Th</span>
|
|
367
|
+
<span class="shift"><a href="/~cs150/.Summer20/help-desk/">MS Teams</a></span>
|
|
368
|
+
</td>
|
|
369
|
+
<td>
|
|
370
|
+
|
|
371
|
+
</td>
|
|
372
|
+
<td>
|
|
373
|
+
|
|
374
|
+
</td>
|
|
375
|
+
</tr>
|
|
376
|
+
<tr>
|
|
377
|
+
<td class="time">
|
|
378
|
+
5:00 PM
|
|
379
|
+
</td>
|
|
380
|
+
<td>
|
|
381
|
+
|
|
382
|
+
</td>
|
|
383
|
+
<td>
|
|
384
|
+
|
|
385
|
+
</td>
|
|
386
|
+
<td>
|
|
387
|
+
|
|
388
|
+
</td>
|
|
389
|
+
<td>
|
|
390
|
+
|
|
391
|
+
</td>
|
|
392
|
+
<td>
|
|
393
|
+
|
|
394
|
+
</td>
|
|
395
|
+
<td>
|
|
396
|
+
|
|
397
|
+
</td>
|
|
398
|
+
<td>
|
|
399
|
+
|
|
400
|
+
</td>
|
|
401
|
+
</tr>
|
|
402
|
+
</table>
|
|
403
|
+
```
|
|
404
|
+
|
|
405
|
+
### Enabling Google Analytics
|
|
406
|
+
To enable Google Analytics, add the following lines to your Jekyll site:
|
|
407
|
+
|
|
408
|
+
```
|
|
409
|
+
google_analytics: UA-NNNNNNNN-N
|
|
410
|
+
```
|
|
411
|
+
Google Analytics will only appear in production, i.e., JEKYLL_ENV=production
|
|
412
|
+
|
|
413
|
+
### Enabling Excerpts on the Home Page
|
|
414
|
+
To display post-excerpts on the Home Page, simply add the following to your _config.yml:
|
|
415
|
+
```
|
|
416
|
+
show_excerpts: true
|
|
417
|
+
```
|
|
418
|
+
|
|
419
|
+
### Plugins
|
|
420
|
+
csu-cs comes with the following plugins:
|
|
421
|
+
|
|
422
|
+
* [`jekyll-seo-tag`](https://github.com/jekyll/jekyll-seo-tag) plugin preinstalled to make sure
|
|
423
|
+
your website gets the most useful meta tags.
|
|
424
|
+
See [usage](https://github.com/jekyll/jekyll-seo-tag#usage) to know how to set it up.
|
|
425
|
+
|
|
426
|
+
* [`jekyll-feed`](https://github.com/jekyll/jekyll-feed) - A Jekyll plugin to generate an Atom (RSS-like)
|
|
427
|
+
feed of your Jekyll posts
|
|
428
|
+
|
|
429
|
+
|
|
430
|
+
## Contributing
|
|
431
|
+
|
|
432
|
+
Bug reports and pull requests are welcome on GitHub at
|
|
433
|
+
https://github.com/Dept-of-Computer-Science/jekyll-theme-csu-cs.
|
|
434
|
+
This project is intended to be a safe, welcoming space for collaboration, and contributors are expected
|
|
435
|
+
to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
|
|
436
|
+
|
|
437
|
+
## Development
|
|
438
|
+
|
|
439
|
+
To set up your environment to develop this theme, run `bundle install`.
|
|
440
|
+
|
|
441
|
+
Your theme is setup just like a normal Jekyll site! To test your theme, run `bundle exec jekyll serve`
|
|
442
|
+
and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme.
|
|
443
|
+
Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications
|
|
444
|
+
to your theme and to your content, your site will regenerate and you should see the changes in the browser
|
|
445
|
+
after a refresh, just like normal.
|
|
446
|
+
|
|
447
|
+
## License
|
|
448
|
+
|
|
449
|
+
The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
|
|
450
|
+
|
|
451
|
+
## Acknowledgements
|
|
452
|
+
|
|
453
|
+
* jekyll-minima - The style sheet, and svg icons are based off their original theme. Analytics comes from minima theme.
|
|
454
|
+
* jekyll-feed - Included as part of the gem bundle
|
|
455
|
+
* jekyll-seo - Included as part of the gem bundle
|
|
456
|
+
|