summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authordavidtsadler <davidtsadler@googlemail.com>2011-12-29 07:10:55 +0000
committerdavidtsadler <davidtsadler@googlemail.com>2011-12-29 07:10:55 +0000
commitc1f1822f7ac0fdd6d7c46f71ed9d3705b3b247b5 (patch)
treedf9dd34521fcf0bce05c57e90e7de604b914a0ee
parentf25909f4550932a901daa09dd52bad3f87e842f2 (diff)
Add comments to example configuration file.
-rw-r--r--_config.yml.example18
1 files changed, 14 insertions, 4 deletions
diff --git a/_config.yml.example b/_config.yml.example
index 37b5c32..939cf85 100644
--- a/_config.yml.example
+++ b/_config.yml.example
@@ -2,12 +2,22 @@
# SITE CONFIG
# ***************************
+# Appears in the <title> and <header> elements within the site.
title:
-subtitle:
+# Optional. Appears in the site's main <header> element.
+#subtitle:
+# Used in various places where the author of the site needs to appear.
+# For example, the copyright notice.
author:
-email:
-twitter:
-github:
+
+# Optional information that appears in the 'Contact' sidebar.
+# Mainly used to generate URLs to various social sites.
+# email address of the site author.
+#email:
+# Twitter name minus the @ character.
+#twitter:
+# Git hub name.
+#github: