Skip to content

Commit ac651a1

Browse files
authored
Improve documentation for config options (#760)
Merge pull request 760
1 parent 8537486 commit ac651a1

File tree

1 file changed

+45
-29
lines changed

1 file changed

+45
-29
lines changed

_config.yml

+45-29
Original file line numberDiff line numberDiff line change
@@ -12,46 +12,62 @@ description: >
1212
1313
# Build settings
1414

15+
# If you clone the Minima repo and build locally, use this setting.
1516
theme: minima
1617

18+
# As of November 2023, GitHub Pages still uses Minima 2.5.1 (https://pages.github.com/versions/).
19+
# If you want to use the latest Minima version on GitHub Pages, use the following setting and
20+
# add a line comment on "theme: minima" above.
21+
#remote_theme: jekyll/minima
22+
1723
plugins:
1824
- jekyll-feed
1925
- jekyll-seo-tag
2026

2127
# Theme-specific settings
2228

29+
# If you want to link only specific pages in your header, use this and add the path to the pages
30+
# in order as they should show up.
31+
header_pages:
32+
- about.md
33+
34+
# Set to `true` to show excerpts on the homepage.
35+
#show_excerpts: false
36+
37+
# Minima specific settings, which are only available from Minima 3.0 onward.
2338
minima:
39+
# Minima skin selection.
40+
# Available skins are:
41+
# classic Default, light color scheme.
42+
# dark Dark variant of the classic skin.
43+
# auto Adaptive skin based on the default classic and dark skins.
44+
# solarized-light Light variant of solarized color scheme.
45+
# solarized-dark Dark variant of solarized color scheme.
46+
# solarized Adaptive skin for solarized color scheme skins.
47+
skin: classic
48+
2449
# Minima date format.
50+
# The default value is "%b %d, %Y" (e.g. Nov 14, 2023)
2551
# Refer to https://shopify.github.io/liquid/filters/date/ if you want to customize this.
26-
#
27-
# date_format: "%b %-d, %Y"
52+
#date_format: "%b-%d-%Y"
2853

2954
# Generate social links in footer.
30-
#
31-
# social_links:
32-
# - { platform: devto, user_url: "https://dev.to/jekyll" }
33-
# - { platform: dribbble, user_url: "https://dribbble.com/jekyll" }
34-
# - { platform: facebook, user_url: "https://www.facebook.com/jekyll" }
35-
# - { platform: flickr, user_url: "https://www.flickr.com/photos/jekyll" }
36-
# - { platform: github, user_url: "https://github.com/jekyll/minima" }
37-
# - { platform: google_scholar, user_url: "https://scholar.google.com/citations?user=qc6CJjYAAAAJ" }
38-
# - { platform: instagram, user_url: "https://www.instagram.com/jekyll" }
39-
# - { platform: keybase, user_url: "https://keybase.io/jekyll" }
40-
# - { platform: linkedin, user_url: "https://www.linkedin.com/in/jekyll" }
41-
# - { platform: microdotblog, user_url: "https://micro.blog/jekyll" }
42-
# - { platform: pinterest, user_url: "https://www.pinterest.com/jekyll" }
43-
# - { platform: stackoverflow, user_url: "https://stackoverflow.com/users/1234567/jekyll" }
44-
# - { platform: telegram, user_url: "https://t.me/jekyll" }
45-
# - { platform: twitter, user_url: "https://twitter.com/jekyllrb" }
46-
# - { platform: x, user_url: "https://x.com/jekyllrb" }
47-
# - { platform: youtube, user_url: "https://www.youtube.com/jekyll" }
48-
49-
# If you want to link only specific pages in your header, uncomment this and add the path to the pages in
50-
# order as they should show up.
51-
#
52-
# header_pages:
53-
# - about.md
55+
#social_links:
56+
# - { platform: devto, user_url: "https://dev.to/jekyll" }
57+
# - { platform: dribbble, user_url: "https://dribbble.com/jekyll" }
58+
# - { platform: facebook, user_url: "https://www.facebook.com/jekyll" }
59+
# - { platform: flickr, user_url: "https://www.flickr.com/photos/jekyll" }
60+
# - { platform: github, user_url: "https://github.com/jekyll/minima" }
61+
# - { platform: google_scholar, user_url: "https://scholar.google.com/citations?user=qc6CJjYAAAAJ" }
62+
# - { platform: instagram, user_url: "https://www.instagram.com/jekyll" }
63+
# - { platform: keybase, user_url: "https://keybase.io/jekyll" }
64+
# - { platform: linkedin, user_url: "https://www.linkedin.com/in/jekyll" }
65+
# - { platform: microdotblog, user_url: "https://micro.blog/jekyll" }
66+
# - { platform: pinterest, user_url: "https://www.pinterest.com/jekyll" }
67+
# - { platform: stackoverflow, user_url: "https://stackoverflow.com/users/1234567/jekyll" }
68+
# - { platform: telegram, user_url: "https://t.me/jekyll" }
69+
# - { platform: twitter, user_url: "https://twitter.com/jekyllrb" }
70+
# - { platform: x, user_url: "https://x.com/jekyllrb" }
71+
# - { platform: youtube, user_url: "https://www.youtube.com/jekyll" }
72+
5473

55-
# Set to `true` to show excerpts on the homepage.
56-
#
57-
# show_excerpts: false

0 commit comments

Comments
 (0)