From f8ec113355778ad15b3f4f069cfba0cea4d4df4f Mon Sep 17 00:00:00 2001 From: Tunghsiao Liu Date: Mon, 16 Jan 2017 18:09:20 +0800 Subject: [PATCH] feat(config): better comments for init config --- _config.init.yml | 87 ++++++++++++++++++++++++++++++++++++------------ _config.yml | 76 +++++++++++++++++++++++++++++++++--------- 2 files changed, 126 insertions(+), 37 deletions(-) diff --git a/_config.init.yml b/_config.init.yml index a99172491..b25a9d41c 100644 --- a/_config.init.yml +++ b/_config.init.yml @@ -68,61 +68,90 @@ gems: # # Development mode +# +# Development mode is disabled on production build by default, we've enabled it +# in `_config.dev.yml` for local development, so most of the time you don't +# need to change it. +# +# Default: false dev: false # Site name +# +# Default: Almace Scaffolding name: Almace Scaffolding -# Site description, will appear in the document meta and Atom feed subtitle +# Site description +# +# Will be used in the document meta and Atom feed subtitle +# +# Default: Almace Scaffolding - Super-fast Jekyll framework description: Almace Scaffolding - Super-fast Jekyll framework -# Base URL, this is useful when I need to build site in a subdirectory (like +# 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 https://sparanoid.com/my-project/, set `base` to # `/my-project`, without trailing slash. +# # Default: "" base: "" # CSS path used in templates +# # Default: /assets assets: /assets +# Feed URL +# # Define your main feed URL, this will be only used in your templates +# # Default: /feed.xml feed: /feed.xml -# PubSubHubbub Hub -# Default: https://pubsubhubbub.appspot.com/ -pshh: https://pubsubhubbub.appspot.com/ - +# Site full URL +# # Used in atom feed, sitemap, Twitter Cards, and etc. I should use absolute full # URLs for these fields +# +# Default: https://sparanoid.com url: https://sparanoid.com -# Media assets URL used in posts, without trailing slash. ie. +# Media assets URL +# +# Media assets URL are used in posts, without trailing slash. ie. # ``. In the most cases this URL should be # powered by a CDN provider -# Note: you should avoid protocol-free address (ie. //cdn.mysite.tld) here +# Note: you should avoid protocol-free (ie. //cdn.mysite.tld) address here # because Twitter Cards doesn't work well with protocol-free assets when AMSF # grabs the first image of your post as post featured image. +# +# Default: https://d349cztnlupsuf.cloudfront.net file: https://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 +# +# Download files URL are 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. +# +# Default: https://d1bmx7s6749k4k.cloudfront.net download: https://d1bmx7s6749k4k.cloudfront.net -# Primary color (used by Safari mask-icon) -# Default #ff00b4 -primary_color: '#ff00b4' +# Primary color +# +# Used by Safari mask-icon, Chrome Web App theme color +# +# Default "#ff00b4" +primary_color: "#ff00b4" -# Service Worker Precache support -# Service Worker does not work on HTTP +# Service Worker Precache service_worker: enabled: true - file_globs: + files: - "**/*.{css,html,jpg,gif,png,svg}" - "**/img/**.*" - "**/js/**.js" @@ -136,34 +165,50 @@ google_analytics: # Site Twitter account handle twitter: sparanoid +# Twitter Cards large images +# # Use summary card with large image for Twitter Cards, require theme support +# # Default: true tc_large_image: true -# Force UTF-8 encoding, enable this will simply add to -# the head of your pages +# Force UTF-8 encoding +# +# Enable this will simply add to the head of your pages +# # Default: false force_utf_8: false +# Link blog +# # Enable this settings to make your feed Daring Fireball-like link blog (This # basically change your value to external link you defined in your posts) +# # Default: false link_blog: false +# Excerpts for RSS +# # Change the value to true to use post excerpt for RSS feeds +# # Default: false rss_excerpt: false +# Generator credits +# # Show or hide generator credits, require theme support +# # Default: true credits: true # Custom records in robots.txt +# # For example: # robots: # - "User-agent: *" # - "Disallow: /ajax/" # - "Disallow: /@async" # - "Disallow: /log/" +# # Default: "User-agent: *" robots: "User-agent: *" diff --git a/_config.yml b/_config.yml index 38e6e1d22..23e80ea22 100644 --- a/_config.yml +++ b/_config.yml @@ -68,59 +68,87 @@ gems: # # Development mode +# +# Development mode is disabled on production build by default, we've enabled it +# in `_config.dev.yml` for local development, so most of the time you don't +# need to change it. +# +# Default: false dev: false # Site name +# +# Default: Almace Scaffolding name: Almace Scaffolding -# Site description, will appear in the document meta and Atom feed subtitle +# Site description +# +# Will be used in the document meta and Atom feed subtitle +# +# Default: Almace Scaffolding - Super-fast Jekyll framework description: Almace Scaffolding - Super-fast Jekyll framework -# Base URL, this is useful when I need to build site in a subdirectory (like +# 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 https://sparanoid.com/my-project/, set `base` to # `/my-project`, without trailing slash. +# # Default: "" base: /lab/amsf # CSS path used in templates +# # Default: /assets assets: /assets +# Feed URL +# # Define your main feed URL, this will be only used in your templates +# # Default: /feed.xml feed: /feed.xml -# PubSubHubbub Hub -# Default: https://pubsubhubbub.appspot.com/ -pshh: https://pubsubhubbub.appspot.com/ - +# Site full URL +# # Used in atom feed, sitemap, Twitter Cards, and etc. I should use absolute full # URLs for these fields +# +# Default: https://sparanoid.com url: https://sparanoid.com -# Media assets URL used in posts, without trailing slash. ie. +# Media assets URL +# +# Media assets URL are used in posts, without trailing slash. ie. # ``. In the most cases this URL should be # powered by a CDN provider # Note: you should avoid protocol-free (ie. //cdn.mysite.tld) address here # because Twitter Cards doesn't work well with protocol-free assets when AMSF # grabs the first image of your post as post featured image. +# +# Default: https://d349cztnlupsuf.cloudfront.net file: https://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 +# +# Download files URL are 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. +# +# Default: https://d1bmx7s6749k4k.cloudfront.net download: https://d1bmx7s6749k4k.cloudfront.net # Primary color +# # Used by Safari mask-icon, Chrome Web App theme color +# # Default "#ff00b4" primary_color: "#ff00b4" -# Service Worker Precache support -# Service Worker does not work on HTTP +# Service Worker Precache service_worker: enabled: true files: @@ -137,34 +165,50 @@ google_analytics: # Site Twitter account handle twitter: sparanoid +# Twitter Cards large images +# # Use summary card with large image for Twitter Cards, require theme support +# # Default: true tc_large_image: true -# Force UTF-8 encoding, enable this will simply add to -# the head of your pages +# Force UTF-8 encoding +# +# Enable this will simply add to the head of your pages +# # Default: false force_utf_8: false +# Link blog +# # Enable this settings to make your feed Daring Fireball-like link blog (This # basically change your value to external link you defined in your posts) +# # Default: false link_blog: false +# Excerpts for RSS +# # Change the value to true to use post excerpt for RSS feeds +# # Default: false rss_excerpt: false +# Generator credits +# # Show or hide generator credits, require theme support +# # Default: true credits: true # Custom records in robots.txt +# # For example: # robots: # - "User-agent: *" # - "Disallow: /ajax/" # - "Disallow: /@async" # - "Disallow: /log/" +# # Default: "User-agent: *" robots: "User-agent: *"