|
| 1 | +# Welcome to Jekyll! |
| 2 | +# |
| 3 | +# This config file is meant for settings that affect your entire site, values |
| 4 | +# which you are expected to set up once and rarely need to edit after that. |
| 5 | +# For technical reasons, this file is *NOT* reloaded automatically when you use |
| 6 | +# `jekyll serve`. If you change this file, please restart the server process. |
| 7 | + |
| 8 | +# Theme Settings |
| 9 | +# |
| 10 | +# Review documentation to determine if you should use `theme` or `remote_theme` |
| 11 | +# https://mmistakes.github.io/minimal-mistakes/docs/quick-start-guide/#installing-the-theme |
| 12 | + |
| 13 | +# theme : "minimal-mistakes-jekyll" |
| 14 | +# remote_theme : "mmistakes/minimal-mistakes" |
| 15 | +minimal_mistakes_skin : "default" # "air", "aqua", "contrast", "dark", "dirt", "neon", "mint", "plum", "sunrise" |
| 16 | + |
| 17 | +# Site Settings |
| 18 | +locale : "en-US" |
| 19 | +title : "Site Title" |
| 20 | +title_separator : "-" |
| 21 | +subtitle : # site tagline that appears below site title in masthead |
| 22 | +name : "Your Name" |
| 23 | +description : "An amazing website." |
| 24 | +url : # the base hostname & protocol for your site e.g. "https://mmistakes.github.io" |
| 25 | +baseurl : # the subpath of your site, e.g. "/blog" |
| 26 | +repository : # GitHub username/repo-name e.g. "mmistakes/minimal-mistakes" |
| 27 | +teaser : # path of fallback teaser image, e.g. "/assets/images/500x300.png" |
| 28 | +logo : # path of logo image to display in the masthead, e.g. "/assets/images/88x88.png" |
| 29 | +masthead_title : # overrides the website title displayed in the masthead, use " " for no title |
| 30 | +# breadcrumbs : false # true, false (default) |
| 31 | +words_per_minute : 200 |
| 32 | +comments: |
| 33 | + provider : # false (default), "disqus", "discourse", "facebook", "staticman", "staticman_v2", "utterances", "custom" |
| 34 | + disqus: |
| 35 | + shortname : # https://help.disqus.com/customer/portal/articles/466208-what-s-a-shortname- |
| 36 | + discourse: |
| 37 | + server : # https://meta.discourse.org/t/embedding-discourse-comments-via-javascript/31963 , e.g.: meta.discourse.org |
| 38 | + facebook: |
| 39 | + # https://developers.facebook.com/docs/plugins/comments |
| 40 | + appid : |
| 41 | + num_posts : # 5 (default) |
| 42 | + colorscheme : # "light" (default), "dark" |
| 43 | + utterances: |
| 44 | + theme : # "github-light" (default), "github-dark" |
| 45 | + issue_term : # "pathname" (default) |
| 46 | + staticman: |
| 47 | + branch : # "master" |
| 48 | + endpoint : # "https://{your Staticman v3 API}/v3/entry/github/" |
| 49 | +reCaptcha: |
| 50 | + siteKey : |
| 51 | + secret : |
| 52 | +atom_feed: |
| 53 | + path : # blank (default) uses feed.xml |
| 54 | +search : # true, false (default) |
| 55 | +search_full_content : # true, false (default) |
| 56 | +search_provider : # lunr (default), algolia, google |
| 57 | +algolia: |
| 58 | + application_id : # YOUR_APPLICATION_ID |
| 59 | + index_name : # YOUR_INDEX_NAME |
| 60 | + search_only_api_key : # YOUR_SEARCH_ONLY_API_KEY |
| 61 | + powered_by : # true (default), false |
| 62 | +google: |
| 63 | + search_engine_id : # YOUR_SEARCH_ENGINE_ID |
| 64 | + instant_search : # false (default), true |
| 65 | +# SEO Related |
| 66 | +google_site_verification : |
| 67 | +bing_site_verification : |
| 68 | +yandex_site_verification : |
| 69 | +naver_site_verification : |
| 70 | + |
| 71 | +# Social Sharing |
| 72 | +twitter: |
| 73 | + username : |
| 74 | +facebook: |
| 75 | + username : |
| 76 | + app_id : |
| 77 | + publisher : |
| 78 | +og_image : # Open Graph/Twitter default site image |
| 79 | +# For specifying social profiles |
| 80 | +# - https://developers.google.com/structured-data/customize/social-profiles |
| 81 | +social: |
| 82 | + type : # Person or Organization (defaults to Person) |
| 83 | + name : # If the user or organization name differs from the site's name |
| 84 | + links: # An array of links to social media profiles |
| 85 | + |
| 86 | +# Analytics |
| 87 | +analytics: |
| 88 | + provider : false # false (default), "google", "google-universal", "google-gtag", "custom" |
| 89 | + google: |
| 90 | + tracking_id : |
| 91 | + anonymize_ip : # true, false (default) |
| 92 | + |
| 93 | + |
| 94 | +# Site Author |
| 95 | +author: |
| 96 | + name : "Your Name" |
| 97 | + avatar : # path of avatar image, e.g. "/assets/images/bio-photo.jpg" |
| 98 | + bio : "I am an **amazing** person." |
| 99 | + location : "Somewhere" |
| 100 | + email : |
| 101 | + links: |
| 102 | + - label: "Email" |
| 103 | + icon: "fas fa-fw fa-envelope-square" |
| 104 | + |
| 105 | + - label: "Website" |
| 106 | + icon: "fas fa-fw fa-link" |
| 107 | + # url: "https://your-website.com" |
| 108 | + - label: "Twitter" |
| 109 | + icon: "fab fa-fw fa-twitter-square" |
| 110 | + # url: "https://twitter.com/" |
| 111 | + - label: "Facebook" |
| 112 | + icon: "fab fa-fw fa-facebook-square" |
| 113 | + # url: "https://facebook.com/" |
| 114 | + - label: "GitHub" |
| 115 | + icon: "fab fa-fw fa-github" |
| 116 | + # url: "https://github.com/" |
| 117 | + - label: "Instagram" |
| 118 | + icon: "fab fa-fw fa-instagram" |
| 119 | + # url: "https://instagram.com/" |
| 120 | + |
| 121 | +# Site Footer |
| 122 | +footer: |
| 123 | + links: |
| 124 | + - label: "Twitter" |
| 125 | + icon: "fab fa-fw fa-twitter-square" |
| 126 | + # url: |
| 127 | + - label: "Facebook" |
| 128 | + icon: "fab fa-fw fa-facebook-square" |
| 129 | + # url: |
| 130 | + - label: "GitHub" |
| 131 | + icon: "fab fa-fw fa-github" |
| 132 | + # url: |
| 133 | + - label: "GitLab" |
| 134 | + icon: "fab fa-fw fa-gitlab" |
| 135 | + # url: |
| 136 | + - label: "Bitbucket" |
| 137 | + icon: "fab fa-fw fa-bitbucket" |
| 138 | + # url: |
| 139 | + - label: "Instagram" |
| 140 | + icon: "fab fa-fw fa-instagram" |
| 141 | + # url: |
| 142 | + |
| 143 | + |
| 144 | +# Reading Files |
| 145 | +include: |
| 146 | + - .htaccess |
| 147 | + - _pages |
| 148 | +exclude: |
| 149 | + - "*.sublime-project" |
| 150 | + - "*.sublime-workspace" |
| 151 | + - vendor |
| 152 | + - .asset-cache |
| 153 | + - .bundle |
| 154 | + - .jekyll-assets-cache |
| 155 | + - .sass-cache |
| 156 | + - assets/js/plugins |
| 157 | + - assets/js/_main.js |
| 158 | + - assets/js/vendor |
| 159 | + - Capfile |
| 160 | + - CHANGELOG |
| 161 | + - config |
| 162 | + - Gemfile |
| 163 | + - Gruntfile.js |
| 164 | + - gulpfile.js |
| 165 | + - LICENSE |
| 166 | + - log |
| 167 | + - node_modules |
| 168 | + - package.json |
| 169 | + - package-lock.json |
| 170 | + - Rakefile |
| 171 | + - README |
| 172 | + - tmp |
| 173 | + - /docs # ignore Minimal Mistakes /docs |
| 174 | + - /test # ignore Minimal Mistakes /test |
| 175 | +keep_files: |
| 176 | + - .git |
| 177 | + - .svn |
| 178 | +encoding: "utf-8" |
| 179 | +markdown_ext: "markdown,mkdown,mkdn,mkd,md" |
| 180 | + |
| 181 | + |
| 182 | +# Conversion |
| 183 | +markdown: kramdown |
| 184 | +highlighter: rouge |
| 185 | +lsi: false |
| 186 | +excerpt_separator: "\n\n" |
| 187 | +incremental: false |
| 188 | + |
| 189 | + |
| 190 | +# Markdown Processing |
| 191 | +kramdown: |
| 192 | + input: GFM |
| 193 | + hard_wrap: false |
| 194 | + auto_ids: true |
| 195 | + footnote_nr: 1 |
| 196 | + entity_output: as_char |
| 197 | + toc_levels: 1..6 |
| 198 | + smart_quotes: lsquo,rsquo,ldquo,rdquo |
| 199 | + enable_coderay: false |
| 200 | + |
| 201 | + |
| 202 | +# Sass/SCSS |
| 203 | +sass: |
| 204 | + sass_dir: _sass |
| 205 | + style: compressed # https://sass-lang.com/documentation/file.SASS_REFERENCE.html#output_style |
| 206 | + |
| 207 | + |
| 208 | +# Outputting |
| 209 | +permalink: /:categories/:title/ |
| 210 | +paginate: 5 # amount of posts to show |
| 211 | +paginate_path: /page:num/ |
| 212 | +timezone: # https://en.wikipedia.org/wiki/List_of_tz_database_time_zones |
| 213 | + |
| 214 | + |
| 215 | +# Plugins (previously gems:) |
| 216 | +plugins: |
| 217 | + - jekyll-paginate |
| 218 | + - jekyll-sitemap |
| 219 | + - jekyll-gist |
| 220 | + - jekyll-feed |
| 221 | + - jekyll-include-cache |
| 222 | + |
| 223 | +# mimic GitHub Pages with --safe |
| 224 | +whitelist: |
| 225 | + - jekyll-paginate |
| 226 | + - jekyll-sitemap |
| 227 | + - jekyll-gist |
| 228 | + - jekyll-feed |
| 229 | + - jekyll-include-cache |
| 230 | + |
| 231 | + |
| 232 | +# Archives |
| 233 | +# Type |
| 234 | +# - GitHub Pages compatible archive pages built with Liquid ~> type: liquid (default) |
| 235 | +# - Jekyll Archives plugin archive pages ~> type: jekyll-archives |
| 236 | +# Path (examples) |
| 237 | +# - Archive page should exist at path when using Liquid method or you can |
| 238 | +# expect broken links (especially with breadcrumbs enabled) |
| 239 | +# - <base_path>/tags/my-awesome-tag/index.html ~> path: /tags/ |
| 240 | +# - <base_path>/categories/my-awesome-category/index.html ~> path: /categories/ |
| 241 | +# - <base_path>/my-awesome-category/index.html ~> path: / |
| 242 | +category_archive: |
| 243 | + type: liquid |
| 244 | + path: /categories/ |
| 245 | +tag_archive: |
| 246 | + type: liquid |
| 247 | + path: /tags/ |
| 248 | +# https://github.com/jekyll/jekyll-archives |
| 249 | +# jekyll-archives: |
| 250 | +# enabled: |
| 251 | +# - categories |
| 252 | +# - tags |
| 253 | +# layouts: |
| 254 | +# category: archive-taxonomy |
| 255 | +# tag: archive-taxonomy |
| 256 | +# permalinks: |
| 257 | +# category: /categories/:name/ |
| 258 | +# tag: /tags/:name/ |
| 259 | + |
| 260 | + |
| 261 | +# HTML Compression |
| 262 | +# - https://jch.penibelst.de/ |
| 263 | +compress_html: |
| 264 | + clippings: all |
| 265 | + ignore: |
| 266 | + envs: development |
| 267 | + |
| 268 | + |
| 269 | +# Defaults |
| 270 | +defaults: |
| 271 | + # _posts |
| 272 | + - scope: |
| 273 | + path: "" |
| 274 | + type: posts |
| 275 | + values: |
| 276 | + layout: single |
| 277 | + author_profile: true |
| 278 | + read_time: true |
| 279 | + comments: # true |
| 280 | + share: true |
| 281 | + related: true |
0 commit comments