Skip to content

Commit

Permalink
feat(config): update comment for better readability
Browse files Browse the repository at this point in the history
  • Loading branch information
sparanoid committed Jun 6, 2016
1 parent 6617343 commit 16911d8
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 15 deletions.
25 changes: 18 additions & 7 deletions _config.init.yml
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,10 @@ name: Almace Scaffolding
# Site description, will appear in the document meta and Atom feed subtitle
description: Almace Scaffolding - Super-fast Jekyll framework

# Base URL, this is useful when I need to build site in a subdirectory (like GitHub Pages for Projects), it provides a specific URL prefix, for example, if the production site URL is http://sparanoid.com/lab/version/, set `base` to `/lab/version/24`, without trailing slash.
# Base URL, this is useful when I need to build site in a subdirectory (like
# GitHub Pages for Projects), it provides a specific URL prefix, for example, if
# the production site URL is http://sparanoid.com/lab/version/, set `base` to
# `/lab/version/24`, without trailing slash.
# Default: ""
base: ""

Expand All @@ -91,13 +94,20 @@ feed: /feed.xml
# Default: https://pubsubhubbub.appspot.com/
pshh: https://pubsubhubbub.appspot.com/

# Used in atom feed, sitemap, Twitter Cards, and etc. I should use absolute full URLs for these fields
# Used in atom feed, sitemap, Twitter Cards, and etc. I should use absolute full
# URLs for these fields
url: http://sparanoid.com

# Media assets URL used in posts, without trailing slash. ie. `<img src="{{ site.file }}/image.png">`. In the most cases this URL should be powered by a CDN provider
# Media assets URL used in posts, without trailing slash. ie.
# `<img src="{{ site.file }}/image.png">`. In the most cases this URL should be
# powered by a CDN provider
file: //d349cztnlupsuf.cloudfront.net

# Download files URL used in posts, ie. href="{{ site.download }}/package.zip", this should also be a CDN link just like `site.file`. There're no notable differences in `site.file` and `site.download`, I just use the one for post images and the other for large download files. That's it. Remove or ignore this if you don't need it.
# Download files URL used in posts, ie. href="{{ site.download }}/package.zip",
# this should also be a CDN link just like `site.file`. There're no notable
# differences in `site.file` and `site.download`, I just use the one for post
# images and the other for large download files. That's it. Remove or ignore
# this if you don't need it.
download: http://dl.sparanoid.com

# Google Analytics tracking code
Expand All @@ -109,12 +119,13 @@ google_analytics:
# Site Twitter account handle
twitter: sparanoid

# Force UTF-8 encoding, enable this will simply add <meta charset="utf-8"> to the head of your pages
# Force UTF-8 encoding, enable this will simply add <meta charset="utf-8"> to
# the head of your pages
# Default: false
force_utf_8: false

# Enable this settings to make your feed Daring Fireball-like link blog
# (This basically change your <link> value to external link you defined in your posts)
# Enable this settings to make your feed Daring Fireball-like link blog (This
# basically change your <link> value to external link you defined in your posts)
# Default: false
link_blog: false

Expand Down
37 changes: 29 additions & 8 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,16 @@ kramdown:
transliterated_header_ids: true
footnote_backlink: "&#8617;&#xfe0e;"

redcarpet:
extensions:
- footnotes
- no_intra_emphasis
- smart
- space_after_headers
- strikethrough
- superscript
- tables

#
# Jekyll plugins
#
Expand All @@ -65,7 +75,10 @@ name: Almace Scaffolding
# Site description, will appear in the document meta and Atom feed subtitle
description: Almace Scaffolding - Super-fast Jekyll framework

# Base URL, this is useful when I need to build site in a subdirectory (like GitHub Pages for Projects), it provides a specific URL prefix, for example, if the production site URL is http://sparanoid.com/lab/version/, set `base` to `/lab/version/24`, without trailing slash.
# Base URL, this is useful when I need to build site in a subdirectory (like
# GitHub Pages for Projects), it provides a specific URL prefix, for example, if
# the production site URL is http://sparanoid.com/lab/version/, set `base` to
# `/lab/version/24`, without trailing slash.
# Default: ""
base: /lab/amsf

Expand All @@ -81,13 +94,20 @@ feed: /feed.xml
# Default: https://pubsubhubbub.appspot.com/
pshh: https://pubsubhubbub.appspot.com/

# Used in atom feed, sitemap, Twitter Cards, and etc. I should use absolute full URLs for these fields
# Used in atom feed, sitemap, Twitter Cards, and etc. I should use absolute full
# URLs for these fields
url: http://sparanoid.com

# Media assets URL used in posts, without trailing slash. ie. `<img src="{{ site.file }}/image.png">`. In the most cases this URL should be powered by a CDN provider
# Media assets URL used in posts, without trailing slash. ie.
# `<img src="{{ site.file }}/image.png">`. In the most cases this URL should be
# powered by a CDN provider
file: //d349cztnlupsuf.cloudfront.net

# Download files URL used in posts, ie. href="{{ site.download }}/package.zip", this should also be a CDN link just like `site.file`. There're no notable differences in `site.file` and `site.download`, I just use the one for post images and the other for large download files. That's it. Remove or ignore this if you don't need it.
# Download files URL used in posts, ie. href="{{ site.download }}/package.zip",
# this should also be a CDN link just like `site.file`. There're no notable
# differences in `site.file` and `site.download`, I just use the one for post
# images and the other for large download files. That's it. Remove or ignore
# this if you don't need it.
download: http://dl.sparanoid.com

# Google Analytics tracking code
Expand All @@ -99,12 +119,13 @@ google_analytics:
# Site Twitter account handle
twitter: sparanoid

# Force UTF-8 encoding, enable this will simply add <meta charset="utf-8"> to the head of your pages
# Force UTF-8 encoding, enable this will simply add <meta charset="utf-8"> to
# the head of your pages
# Default: false
force_utf_8: false

# Enable this settings to make your feed Daring Fireball-like link blog
# (This basically change your <link> value to external link you defined in your posts)
# Enable this settings to make your feed Daring Fireball-like link blog (This
# basically change your <link> value to external link you defined in your posts)
# Default: false
link_blog: false

Expand All @@ -116,7 +137,7 @@ rss_excerpt: false
# Default: true
credits: true

# Items in robots.txt
# Custom records in robots.txt
# For example:
# robots:
# - "User-agent: *"
Expand Down

0 comments on commit 16911d8

Please sign in to comment.