Skip to content

Instantly share code, notes, and snippets.

@GingerGraham
Last active January 3, 2022 07:00
Show Gist options
  • Save GingerGraham/70d32cd4da78b03d95a7050602638875 to your computer and use it in GitHub Desktop.
Save GingerGraham/70d32cd4da78b03d95a7050602638875 to your computer and use it in GitHub Desktop.
Jekyll Template Files
This gist includes the following sample files:
- _config.yml
- Gemfile
- template Markdown file with Front Matters
# Theme - Optional
theme: minimal-mistakes-jekyll
minimal_mistakes_skin: "dark" # "air", "aqua", "contrast", "dark", "default", "dirt", "neon", "mint", "plum", "sunrise"
# Site Settings
title: # Title of the site
title_separator: "|"
subtitle: # site tagline that appears below site title in masthead
masthead_title: "" # overrides the website title displayed in the masthead, use " " for no title
name: #Site name
description: # Briefly describe your site
url: # site URL
# baseurl: "/blog"
repository: # GitHub (or other) repository identifier <username>/<repo-name>
teaser: # "/assets/images/blog-teaser.jpg"
logo: #"/assets/images/88x88.png"
breadcrumbs: true
timezone: "EUROPE/LONDON"
locale: "en_GB"
words_per_minute: 200
# Where things are
source : ./src # What is your source/root directory?
destination : ./_site # Where do you want your built site? Default is ./_site
collections_dir :
plugins_dir : _plugins # takes an array of strings and loads plugins in that order
layouts_dir : _layouts
data_dir : _data
includes_dir : _includes
sass:
sass_dir: _sass
collections:
authors:
posts:
output : true
# Handling Reading
safe: false
include:
- ".htaccess"
- _pages
exclude:
- "Gemfile"
- "Gemfile.lock"
- "node_modules"
- "vendor/bundle/"
- "vendor/cache/"
- "vendor/gems/"
- "vendor/ruby/"
- "Thumbs.db"
- ".DS_Store"
- .asset-cache
- .bundle
- .jekyll-assets-cache
- .sass-cache
- assets/js/plugins
- assets/js/_main.js
- assets/js/vendor
- Capfile
- CHANGELOG
- config
- Gruntfile.js
- gulpfile.js
- log
- node_modules
- package.json
- package-lock.json
- Rakefile
- README
- "readme.md"
- "LICENSE"
- tmp
keep_files:
- .git
- .svn
encoding : "utf-8"
markdown_ext : "markdown,mkdown,mkdn,mkd,md"
strict_front_matter : false
# Filtering Content
show_drafts : false
limit_posts : 0
future : false
unpublished : false
# Plugins (previously gems:)
plugins:
- jekyll-feed
- jekyll-seo-tag
- jekyll-paginate
- jekyll-gist
- jekyll-include-cache
- jekyll-coffeescript
- jekyll-archives
- jekyll-redirect-from
- jekyll-sitemap
# mimic GitHub Pages with --safe
whitelist:
- jekyll-feed
- jekyll-seo-tag
- jekyll-paginate
- jekyll-gist
- jekyll-include-cache
- jekyll-coffeescript
- jekyll-archives
- jekyll-redirect-from
- jekyll-sitemap
# Conversion
markdown : kramdown
highlighter : rouge
lsi : false
excerpt_separator : "\n\n"
incremental : false
# Serving
detach : false
port : 4000
host : 127.0.0.1
show_dir_listing : false
# HTML Compression
# - https://jch.penibelst.de/
compress_html:
clippings: all
ignore:
envs: development
# Outputting
permalink: pretty
paginate: 10
paginate_pat: /page:num
date_format: "%Y-%m-%d"
quiet : false
verbose : false
defaults:
# _posts
- scope:
path: ""
type: posts
values:
layout: single
classes: wide
show_date: true
read_time: true
comments: false
author_profile: true
share: true
related: true
# pages
- scope:
path: ""
type: pages
values:
layout: single
classes: wide
show_date: true
read_time: true
comments: false
author_profile: true
share: false
related: true
liquid:
error_mode : warn
# strict_filters : false
# strict_variables : false
# Markdown Processors
kramdown:
auto_ids : true
entity_output : as_char
toc_levels : [1, 2, 3, 4, 5, 6]
smart_quotes : lsquo,rsquo,ldquo,rdquo
input : GFM
hard_wrap : false
footnote_nr : 1
show_warnings : false
# SEO Related
google_site_verification :
bing_site_verification :
naver_site_verification :
yandex_site_verification :
baidu_site_verification :
# Analytics
analytics:
provider: false # false (default), "google", "google-universal", "google-gtag", "custom"
google:
tracking_id:
anonymize_ip: true # false (default)
reCaptcha:
siteKey :
secret :
atom_feed:
path : # blank (default) uses feed.xml
hide : # true, false (default)
search : # true, false (default)
search_full_content : # true, false (default)
search_provider : # lunr (default), algolia, google
algolia:
application_id : # YOUR_APPLICATION_ID
index_name : # YOUR_INDEX_NAME
search_only_api_key : # YOUR_SEARCH_ONLY_API_KEY
powered_by : # true (default), false
google:
search_engine_id : # YOUR_SEARCH_ENGINE_ID
instant_search : # false (default), true
# Site Author
author:
name: # Author's Name
avatar: # "/assets/images/bio-photo.jpg"
bio: # Quick description of the author
location: # Your location
email: # Your email address
links:
- label: "Email"
icon: "fas fa-fw fa-envelope-square"
url: # Your email address
- label: "Website"
icon: "fas fa-fw fa-link"
url: # Your website URL
- label: "LinkedIn"
icon: "fab fa-fw fa-linkedin"
url: # Your profile URL
- label: "Twitter"
icon: "fab fa-fw fa-twitter-square"
url: # Your profile URL
# - label: "Facebook"
# icon: "fab fa-fw fa-facebook-square"
# url: # Your profile URL
# - label: "Instagram"
# icon: "fab fa-fw fa-instagram"
# url: # Your profile URL
- label: "Stack Overflow"
icon: "fab fa-fw fa-stack-overflow"
url: # Your profile URL
- label: "GitHub"
icon: "fab fa-fw fa-github"
url: # Your profile URL
# - label: "GitLab"
# icon: "fab fa-fw fa-gitlab"
# url: # Your profile URL
# - label: "Bitbucket"
# icon: "fab fa-fw fa-bitbucket"
# url: # Your profile URL
# Site Footer
footer:
links:
- label: "LinkedIn"
icon: "fab fa-fw fa-linkedin"
url: # Your profile URL
- label: "Twitter"
icon: "fab fa-fw fa-twitter-square"
url: # Your profile URL
# - label: "Facebook"
# icon: "fab fa-fw fa-facebook-square"
# url: # Your profile URL
# - label: "Instagram"
# icon: "fab fa-fw fa-instagram"
# url: # Your profile URL
- label: "Stack Overflow"
icon: "fab fa-fw fa-stack-overflow"
url: # Your profile URL
- label: "GitHub"
icon: "fab fa-fw fa-github"
url: # Your profile URL
# - label: "GitLab"
# icon: "fab fa-fw fa-gitlab"
# url: # Your profile URL
# - label: "Bitbucket"
# icon: "fab fa-fw fa-bitbucket"
# url: # Your profile URL
# Social Sharing
twitter:
username:
facebook:
username:
app_id:
publisher:
og_image: # Open Graph/Twitter default site image
# For specifying social profiles
# - https://developers.google.com/structured-data/customize/social-profiles
social:
type: # or Organization (defaults to Person)
name: # If the user or organization name differs from the site's name
links:
# An array of links to social media profiles
- label: "LinkedIn"
icon: "fab fa-fw fa-linkedin"
url: # Your profile URL
- label: "Twitter"
icon: "fab fa-fw fa-twitter-square"
url: # Your profile URL
# - label: "Facebook"
# icon: "fab fa-fw fa-facebook-square"
# url: # Your profile URL
# - label: "Instagram"
# icon: "fab fa-fw fa-instagram"
# url: # Your profile URL
- label: "Stack Overflow"
icon: "fab fa-fw fa-stack-overflow"
url: # Your profile URL
- label: "GitHub"
icon: "fab fa-fw fa-github"
url: # Your profile URL
# - label: "GitLab"
# icon: "fab fa-fw fa-gitlab"
# url: # Your profile URL
# - label: "Bitbucket"
# icon: "fab fa-fw fa-bitbucket"
# url: # Your profile URL
comments:
provider : # false (default), "disqus", "discourse", "facebook", "staticman", "staticman_v2", "utterances", "giscus", "custom"
disqus:
shortname : # https://help.disqus.com/customer/portal/articles/466208-what-s-a-shortname-
discourse:
server : # https://meta.discourse.org/t/embedding-discourse-comments-via-javascript/31963 , e.g.: meta.discourse.org
facebook:
# https://developers.facebook.com/docs/plugins/comments
appid :
num_posts : # 5 (default)
colorscheme : # "light" (default), "dark"
utterances:
theme : # "github-light" (default), "github-dark"
issue_term : # "pathname" (default)
giscus:
repo_id : # Shown during giscus setup at https://giscus.app
category_name : # Full text name of the category
category_id : # Shown during giscus setup at https://giscus.app
discussion_term : # "pathname" (default), "url", "title", "og:title"
reactions_enabled : # '1' for enabled (default), '0' for disabled
theme : # "light" (default), "dark", "dark_dimmed", "transparent_dark", "preferred_color_scheme"
staticman:
branch : # "master"
endpoint : # "https://{your Staticman v3 API}/v3/entry/github/"
author title excerpt last_modified_at toc header
{"site.author"=>nil}
Title
Brief synopsis of the page
false
teaser
source "https://rubygems.org"
# Core site
gem "jekyll"
# theme
gem "minimal-mistakes-jekyll"
# plugins
group :jekyll_plugins do
gem "jekyll-gist"
gem "jekyll-feed"
gem "jekyll-seo-tag"
gem "jekyll-paginate"
gem "jekyll-include-cache"
gem "jekyll-coffeescript"
gem "jekyll-archives"
gem "jekyll-redirect-from"
gem "jekyll-sitemap"
end
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment