From ac651a1e62473e04bdc322250974ae3d668f5182 Mon Sep 17 00:00:00 2001 From: Because789 Date: Fri, 17 Nov 2023 02:11:14 +0100 Subject: [PATCH] Improve documentation for config options (#760) Merge pull request 760 --- _config.yml | 74 ++++++++++++++++++++++++++++++++--------------------- 1 file changed, 45 insertions(+), 29 deletions(-) diff --git a/_config.yml b/_config.yml index 1bf1afda49..060ab67c27 100644 --- a/_config.yml +++ b/_config.yml @@ -12,46 +12,62 @@ description: > # Build settings +# If you clone the Minima repo and build locally, use this setting. theme: minima +# As of November 2023, GitHub Pages still uses Minima 2.5.1 (https://pages.github.com/versions/). +# If you want to use the latest Minima version on GitHub Pages, use the following setting and +# add a line comment on "theme: minima" above. +#remote_theme: jekyll/minima + plugins: - jekyll-feed - jekyll-seo-tag # Theme-specific settings +# If you want to link only specific pages in your header, use this and add the path to the pages +# in order as they should show up. +header_pages: + - about.md + +# Set to `true` to show excerpts on the homepage. +#show_excerpts: false + +# Minima specific settings, which are only available from Minima 3.0 onward. minima: + # Minima skin selection. + # Available skins are: + # classic Default, light color scheme. + # dark Dark variant of the classic skin. + # auto Adaptive skin based on the default classic and dark skins. + # solarized-light Light variant of solarized color scheme. + # solarized-dark Dark variant of solarized color scheme. + # solarized Adaptive skin for solarized color scheme skins. + skin: classic + # Minima date format. + # The default value is "%b %d, %Y" (e.g. Nov 14, 2023) # Refer to https://shopify.github.io/liquid/filters/date/ if you want to customize this. - # - # date_format: "%b %-d, %Y" + #date_format: "%b-%d-%Y" # Generate social links in footer. - # - # social_links: - # - { platform: devto, user_url: "https://dev.to/jekyll" } - # - { platform: dribbble, user_url: "https://dribbble.com/jekyll" } - # - { platform: facebook, user_url: "https://www.facebook.com/jekyll" } - # - { platform: flickr, user_url: "https://www.flickr.com/photos/jekyll" } - # - { platform: github, user_url: "https://github.com/jekyll/minima" } - # - { platform: google_scholar, user_url: "https://scholar.google.com/citations?user=qc6CJjYAAAAJ" } - # - { platform: instagram, user_url: "https://www.instagram.com/jekyll" } - # - { platform: keybase, user_url: "https://keybase.io/jekyll" } - # - { platform: linkedin, user_url: "https://www.linkedin.com/in/jekyll" } - # - { platform: microdotblog, user_url: "https://micro.blog/jekyll" } - # - { platform: pinterest, user_url: "https://www.pinterest.com/jekyll" } - # - { platform: stackoverflow, user_url: "https://stackoverflow.com/users/1234567/jekyll" } - # - { platform: telegram, user_url: "https://t.me/jekyll" } - # - { platform: twitter, user_url: "https://twitter.com/jekyllrb" } - # - { platform: x, user_url: "https://x.com/jekyllrb" } - # - { platform: youtube, user_url: "https://www.youtube.com/jekyll" } - -# If you want to link only specific pages in your header, uncomment this and add the path to the pages in -# order as they should show up. -# -# header_pages: -# - about.md + #social_links: + # - { platform: devto, user_url: "https://dev.to/jekyll" } + # - { platform: dribbble, user_url: "https://dribbble.com/jekyll" } + # - { platform: facebook, user_url: "https://www.facebook.com/jekyll" } + # - { platform: flickr, user_url: "https://www.flickr.com/photos/jekyll" } + # - { platform: github, user_url: "https://github.com/jekyll/minima" } + # - { platform: google_scholar, user_url: "https://scholar.google.com/citations?user=qc6CJjYAAAAJ" } + # - { platform: instagram, user_url: "https://www.instagram.com/jekyll" } + # - { platform: keybase, user_url: "https://keybase.io/jekyll" } + # - { platform: linkedin, user_url: "https://www.linkedin.com/in/jekyll" } + # - { platform: microdotblog, user_url: "https://micro.blog/jekyll" } + # - { platform: pinterest, user_url: "https://www.pinterest.com/jekyll" } + # - { platform: stackoverflow, user_url: "https://stackoverflow.com/users/1234567/jekyll" } + # - { platform: telegram, user_url: "https://t.me/jekyll" } + # - { platform: twitter, user_url: "https://twitter.com/jekyllrb" } + # - { platform: x, user_url: "https://x.com/jekyllrb" } + # - { platform: youtube, user_url: "https://www.youtube.com/jekyll" } + -# Set to `true` to show excerpts on the homepage. -# -# show_excerpts: false