Skip to content

Commit 9b3a325

Browse files
committed
Document and reorganize _config.yml
1 parent 3f0579c commit 9b3a325

File tree

1 file changed

+48
-10
lines changed

1 file changed

+48
-10
lines changed

_config.yml

Lines changed: 48 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,44 @@
11
# This is the default format.
22
# For more see: https://github.com/mojombo/jekyll/wiki/Permalinks
33
permalink: /:categories/:year/:month/:day/:title
4+
5+
exclude: [".rbenv-version", "README.md", "Rakefile"]
46
auto: true
57
pygments: true
68

7-
production_url : http://username.github.com # or your custom domain name
8-
title : Jekyll Bootstrap
9+
# The production_url is only used when full-domain names are needed
10+
# such as sitemap.txt
11+
# Most places will/should use BASE_PATH to make the urls
12+
#
13+
# If you have set a CNAME (pages.github.com) set your custom domain here.
14+
# Else if you are pushing to username.github.com, replace with your username.
15+
# Finally if you are pushing to a GitHub project page, include the project name at the end.
16+
#
17+
production_url : http://username.github.com
918

19+
# Themes are encouraged to use these universal variables
20+
# so be sure to set them if your theme uses them.
21+
#
22+
title : Jekyll Bootstrap
1023
author :
1124
name : Name Lastname
1225
email : blah@email.test
1326
github : username
1427
twitter : username
1528
feedburner : feedname
1629

17-
exclude: [".rbenv-version", "README.md", "Rakefile"]
18-
19-
# Jekyll-Bootstrap configurations
30+
# All Jekyll-Bootstrap specific configurations are namespaced into this hash
31+
#
2032
JB :
2133

2234
# All links will be namespaced by BASE_PATH if defined.
2335
# This is required for hosting GitHub Project Pages.
2436
# If you are deploying this website for one of your GitHub projects
2537
# you must set BASE_PATH to the name of your GitHub project.
2638
#
39+
# Leave this blank if you have defined a CNAME for your site (pages.github.com)
40+
# NOTE: When in localhost, your site will run from root "/" regardless of BASE_PATH
41+
#
2742
BASE_PATH : "/narly"
2843

2944
# By default, the asset_path is automatically defined relative to BASE_PATH plus the enabled theme.
@@ -38,11 +53,15 @@ JB :
3853

3954
# These paths are to the main pages Jekyll-Bootstrap ships with.
4055
# Some JB helpers refer to these paths; change theme here if needed.
41-
#
56+
#
4257
archive_path: /archive.html
4358
categories_path : /categories.html
4459
tags_path : /tags.html
45-
60+
61+
# Settings for comments helper
62+
# Set 'engine' to the comment engine you want to use.
63+
# Set 'engine' to false to turn commenting off globally.
64+
#
4665
comments :
4766
engine : disqus
4867
disqus :
@@ -54,14 +73,33 @@ JB :
5473
facebook :
5574
apikey : 123
5675

57-
76+
# Settings for analytics helper
77+
# Set 'engine' to the analytics engine you want to use.
78+
# Set 'engine' to false to turn analytics off globally.
79+
#
5880
analytics :
5981
engine : google
6082
google :
6183
tracking_id : 'UA-123-12'
6284
getclicky :
6385
site_id :
6486

65-
87+
# Settings for sharing helper.
88+
# Sharing is for things like tweet, plusone, like, reddit buttons etc.
89+
# Set 'engine' to the sharing engine you want to use.
90+
# Set 'engine' to false to turn sharing off globally.
91+
#
6692
sharing :
67-
engine : false
93+
engine : false
94+
95+
# Settings for all other include helpers can be defined by creating
96+
# a hash with key named for the given helper. ex:
97+
#
98+
# pages_list :
99+
# engine : "custom"
100+
#
101+
# Setting any helper's engine to 'custom' will bypass the helper code
102+
# and include your custom code. Your custom file must be defined at:
103+
# ./_includes/custom/[HELPER]
104+
# where [HELPER] is the name of the helper you are overriding.
105+

0 commit comments

Comments
 (0)