mirror of
https://github.com/hacks-guide/minimal-mistakes.git
synced 2024-11-27 02:40:32 +00:00
4b6b76853f
Every site should support https by now. Better to link the https sites right away. Both sites do support https at the time I checked.
295 lines
8.6 KiB
YAML
295 lines
8.6 KiB
YAML
# Welcome to Jekyll!
|
|
#
|
|
# This config file is meant for settings that affect your entire site, values
|
|
# which you are expected to set up once and rarely need to edit after that.
|
|
# For technical reasons, this file is *NOT* reloaded automatically when you use
|
|
# `jekyll serve`. If you change this file, please restart the server process.
|
|
|
|
# Theme Settings
|
|
#
|
|
# Review documentation to determine if you should use `theme` or `remote_theme`
|
|
# https://mmistakes.github.io/minimal-mistakes/docs/quick-start-guide/#installing-the-theme
|
|
|
|
# theme : "minimal-mistakes-jekyll"
|
|
# remote_theme : "mmistakes/minimal-mistakes"
|
|
minimal_mistakes_skin : "default" # "air", "aqua", "contrast", "dark", "dirt", "neon", "mint", "plum", "sunrise"
|
|
|
|
# Site Settings
|
|
locale : "en-US"
|
|
title : "Site Title"
|
|
title_separator : "-"
|
|
subtitle : # site tagline that appears below site title in masthead
|
|
name : "Your Name"
|
|
description : "An amazing website."
|
|
url : # the base hostname & protocol for your site e.g. "https://mmistakes.github.io"
|
|
baseurl : # the subpath of your site, e.g. "/blog"
|
|
repository : # GitHub username/repo-name e.g. "mmistakes/minimal-mistakes"
|
|
teaser : # path of fallback teaser image, e.g. "/assets/images/500x300.png"
|
|
logo : # path of logo image to display in the masthead, e.g. "/assets/images/88x88.png"
|
|
masthead_title : # overrides the website title displayed in the masthead, use " " for no title
|
|
# breadcrumbs : false # true, false (default)
|
|
words_per_minute : 200
|
|
comments:
|
|
provider : # false (default), "disqus", "discourse", "facebook", "staticman", "staticman_v2", "utterances", "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)
|
|
staticman:
|
|
allowedFields : # ['name', 'email', 'url', 'message']
|
|
branch : # "master"
|
|
commitMessage : # "New comment by {fields.name}"
|
|
filename : # comment-{@timestamp}
|
|
format : # "yml"
|
|
moderation : # true
|
|
path : # "/_data/comments/{options.slug}" (default)
|
|
requiredFields : # ['name', 'email', 'message']
|
|
transforms:
|
|
email : # "md5"
|
|
generatedFields:
|
|
date:
|
|
type : # "date"
|
|
options:
|
|
format : # "iso8601" (default), "timestamp-seconds", "timestamp-milliseconds"
|
|
endpoint : # URL of your own deployment with trailing slash, will fallback to the public instance
|
|
reCaptcha:
|
|
siteKey :
|
|
secret :
|
|
atom_feed:
|
|
path : # blank (default) uses feed.xml
|
|
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
|
|
# SEO Related
|
|
google_site_verification :
|
|
bing_site_verification :
|
|
yandex_site_verification :
|
|
naver_site_verification :
|
|
|
|
# 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 : # Person 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
|
|
|
|
# Analytics
|
|
analytics:
|
|
provider : false # false (default), "google", "google-universal", "custom"
|
|
google:
|
|
tracking_id :
|
|
anonymize_ip : # true, false (default)
|
|
|
|
|
|
# Site Author
|
|
author:
|
|
name : "Your Name"
|
|
avatar : # path of avatar image, e.g. "/assets/images/bio-photo.jpg"
|
|
bio : "I am an **amazing** person."
|
|
location : "Somewhere"
|
|
email :
|
|
links:
|
|
- label: "Email"
|
|
icon: "fas fa-fw fa-envelope-square"
|
|
# url: mailto:your.name@email.com
|
|
- label: "Website"
|
|
icon: "fas fa-fw fa-link"
|
|
# url: "https://your-website.com"
|
|
- label: "Twitter"
|
|
icon: "fab fa-fw fa-twitter-square"
|
|
# url: "https://twitter.com/"
|
|
- label: "Facebook"
|
|
icon: "fab fa-fw fa-facebook-square"
|
|
# url: "https://facebook.com/"
|
|
- label: "GitHub"
|
|
icon: "fab fa-fw fa-github"
|
|
# url: "https://github.com/"
|
|
- label: "Instagram"
|
|
icon: "fab fa-fw fa-instagram"
|
|
# url: "https://instagram.com/"
|
|
|
|
# Site Footer
|
|
footer:
|
|
links:
|
|
- label: "Twitter"
|
|
icon: "fab fa-fw fa-twitter-square"
|
|
# url:
|
|
- label: "Facebook"
|
|
icon: "fab fa-fw fa-facebook-square"
|
|
# url:
|
|
- label: "GitHub"
|
|
icon: "fab fa-fw fa-github"
|
|
# url:
|
|
- label: "GitLab"
|
|
icon: "fab fa-fw fa-gitlab"
|
|
# url:
|
|
- label: "Bitbucket"
|
|
icon: "fab fa-fw fa-bitbucket"
|
|
# url:
|
|
- label: "Instagram"
|
|
icon: "fab fa-fw fa-instagram"
|
|
# url:
|
|
|
|
|
|
# Reading Files
|
|
include:
|
|
- .htaccess
|
|
- _pages
|
|
exclude:
|
|
- "*.sublime-project"
|
|
- "*.sublime-workspace"
|
|
- vendor
|
|
- .asset-cache
|
|
- .bundle
|
|
- .jekyll-assets-cache
|
|
- .sass-cache
|
|
- assets/js/plugins
|
|
- assets/js/_main.js
|
|
- assets/js/vendor
|
|
- Capfile
|
|
- CHANGELOG
|
|
- config
|
|
- Gemfile
|
|
- Gruntfile.js
|
|
- gulpfile.js
|
|
- LICENSE
|
|
- log
|
|
- node_modules
|
|
- package.json
|
|
- Rakefile
|
|
- README
|
|
- tmp
|
|
- /docs # ignore Minimal Mistakes /docs
|
|
- /test # ignore Minimal Mistakes /test
|
|
keep_files:
|
|
- .git
|
|
- .svn
|
|
encoding: "utf-8"
|
|
markdown_ext: "markdown,mkdown,mkdn,mkd,md"
|
|
|
|
|
|
# Conversion
|
|
markdown: kramdown
|
|
highlighter: rouge
|
|
lsi: false
|
|
excerpt_separator: "\n\n"
|
|
incremental: false
|
|
|
|
|
|
# Markdown Processing
|
|
kramdown:
|
|
input: GFM
|
|
hard_wrap: false
|
|
auto_ids: true
|
|
footnote_nr: 1
|
|
entity_output: as_char
|
|
toc_levels: 1..6
|
|
smart_quotes: lsquo,rsquo,ldquo,rdquo
|
|
enable_coderay: false
|
|
|
|
|
|
# Sass/SCSS
|
|
sass:
|
|
sass_dir: _sass
|
|
style: compressed # https://sass-lang.com/documentation/file.SASS_REFERENCE.html#output_style
|
|
|
|
|
|
# Outputting
|
|
permalink: /:categories/:title/
|
|
paginate: 5 # amount of posts to show
|
|
paginate_path: /page:num/
|
|
timezone: # https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
|
|
|
|
|
|
# Plugins (previously gems:)
|
|
plugins:
|
|
- jekyll-paginate
|
|
- jekyll-sitemap
|
|
- jekyll-gist
|
|
- jekyll-feed
|
|
- jekyll-include-cache
|
|
|
|
# mimic GitHub Pages with --safe
|
|
whitelist:
|
|
- jekyll-paginate
|
|
- jekyll-sitemap
|
|
- jekyll-gist
|
|
- jekyll-feed
|
|
- jekyll-include-cache
|
|
|
|
|
|
# Archives
|
|
# Type
|
|
# - GitHub Pages compatible archive pages built with Liquid ~> type: liquid (default)
|
|
# - Jekyll Archives plugin archive pages ~> type: jekyll-archives
|
|
# Path (examples)
|
|
# - Archive page should exist at path when using Liquid method or you can
|
|
# expect broken links (especially with breadcrumbs enabled)
|
|
# - <base_path>/tags/my-awesome-tag/index.html ~> path: /tags/
|
|
# - <base_path>/categories/my-awesome-category/index.html ~> path: /categories/
|
|
# - <base_path>/my-awesome-category/index.html ~> path: /
|
|
category_archive:
|
|
type: liquid
|
|
path: /categories/
|
|
tag_archive:
|
|
type: liquid
|
|
path: /tags/
|
|
# https://github.com/jekyll/jekyll-archives
|
|
# jekyll-archives:
|
|
# enabled:
|
|
# - categories
|
|
# - tags
|
|
# layouts:
|
|
# category: archive-taxonomy
|
|
# tag: archive-taxonomy
|
|
# permalinks:
|
|
# category: /categories/:name/
|
|
# tag: /tags/:name/
|
|
|
|
|
|
# HTML Compression
|
|
# - https://jch.penibelst.de/
|
|
compress_html:
|
|
clippings: all
|
|
ignore:
|
|
envs: development
|
|
|
|
|
|
# Defaults
|
|
defaults:
|
|
# _posts
|
|
- scope:
|
|
path: ""
|
|
type: posts
|
|
values:
|
|
layout: single
|
|
author_profile: true
|
|
read_time: true
|
|
comments: # true
|
|
share: true
|
|
related: true
|