Skip to content

Commit 5620fd4

Browse files
committed
more config notes
1 parent 127b2c8 commit 5620fd4

File tree

2 files changed

+12
-16
lines changed

2 files changed

+12
-16
lines changed

_config.yml

Lines changed: 5 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
1-
# These are things you should customize for your class
1+
# You *MUST* change these two items:
22
title: Your Awesome Class
3+
baseurl: "/jekyll-reveal-starter-kit"
4+
# ^ This is the path of the slide set below the site URL.
5+
6+
# These are things you should customize for your class
37
author: Your Name
48
description: |
59
Your awesome class in all it's glory.
@@ -18,19 +22,6 @@ contact:
1822
twitter: "gdimpls"
1923
github: "gdiminneapolis"
2024

21-
# This is the path of the slide set below
22-
# the site URL. For development purposes,
23-
# the site URL is empty, but when the
24-
# site is published, it should have the
25-
# actual URL. The published URL should
26-
# be set in _publish_config.yml, and
27-
# when the publish step is done, include
28-
# both configurations like so:
29-
#
30-
# jekyll build --config=_config.yml,_config_publish.yml
31-
#
32-
# Further info can be found in the README file.
33-
baseurl: "/jekyll-reveal-starter-kit"
3425

3526
# There are a handful of styles available with reveal. They can be found in the
3627
# reveal.js/css/themes folder, and include:

_config_publish.yml

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,18 @@
1-
# Put configuration items needed exclusively for publishing
1+
# Put configuration items needed exclusively for publishing in this file.
22
#
33
# When performing the Jekyll build for publishing, include this file:
44
#
55
# jekyll build --config=_config.yml,_config_publish.yml
66
#
77

8-
98
# The URL portion is what is substituted in site.url
109
# in the slides. By default, use the GDIMpls Github Pages
1110
# prefix, and the baseurl setting in _config.yml
1211
# for the repository name.
1312
url: "https://gdiminneapolis.github.io"
13+
14+
# If you fork something from the GDIMpls repo into your own repo, and
15+
# use the same publish to Github track, your version will be availble
16+
# at the url "https://<yourgithub>.github.io/<repo-name/". This could
17+
# generate some confusion when contributing to the GDIMpls
18+
# repo. **BEWARE**

0 commit comments

Comments
 (0)