Skip to content

Commit 2740a9f

Browse files
authored
Merge pull request #556 from SayakMukhopadhyay/move-config-yaml
feat: move from a toml hugo config to a yaml one
2 parents d386102 + 6235118 commit 2740a9f

File tree

1 file changed

+100
-95
lines changed

1 file changed

+100
-95
lines changed

hugo.toml renamed to hugo.yaml

+100-95
Original file line numberDiff line numberDiff line change
@@ -1,159 +1,164 @@
1-
baseURL = "https://www.kubernetes.dev/"
2-
title = "Kubernetes Contributors"
3-
theme = ["docsy"]
4-
enableRobotsTXT = true
5-
enableGitInfo = false
1+
baseURL: 'https://www.kubernetes.dev/'
2+
title: Kubernetes Contributors
3+
theme:
4+
- docsy
5+
enableRobotsTXT: true
6+
enableGitInfo: false
67

78
# Language settings
8-
contentDir = "content/en"
9-
defaultContentLanguage = "en"
10-
defaultContentLanguageInSubdir = false
11-
enableMissingTranslationPlaceholders = true
9+
contentDir: content/en
10+
defaultContentLanguage: en
11+
defaultContentLanguageInSubdir: false
12+
enableMissingTranslationPlaceholders: true
1213

13-
disableKinds = ["taxonomy", "taxonomyTerm"]
14+
disableKinds:
15+
- taxonomy
16+
- taxonomyTerm
1417

1518
# Highlighting config
16-
pygmentsCodeFences = true
17-
pygmentsUseClasses = false
18-
pygmentsUseClassic = false
19-
pygmentsStyle = "tango"
19+
pygmentsCodeFences: true
20+
pygmentsUseClasses: false
21+
pygmentsUseClassic: false
22+
pygmentsStyle: tango
2023

2124
# Configure how URLs look like per section.
22-
[permalinks]
23-
blog = "/:section/:year/:month/:day/:slug/"
25+
permalinks:
26+
blog: '/:section/:year/:month/:day/:slug/'
2427

2528

2629
# Image processing configuration.
27-
[imaging]
28-
resampleFilter = "CatmullRom"
29-
quality = 75
30-
anchor = "smart"
30+
imaging:
31+
resampleFilter: CatmullRom
32+
quality: 75
33+
anchor: smart
3134

32-
[services]
33-
[services.googleAnalytics]
35+
services:
36+
googleAnalytics:
3437
# Fake ID in support of [params.ui.feedback]. The real GA ID is set in the Netlify config.
35-
id = "UA-00000000-0"
38+
id: UA-00000000-0
3639

3740
# Hugo internal cacheing
38-
[caches]
39-
[caches.assets]
40-
dir = ":cacheDir/_gen"
41-
maxAge = -1
42-
[caches.getcsv]
43-
dir = ":cacheDir/:project"
44-
maxAge = "60s"
45-
[caches.getjson]
46-
dir = ":cacheDir/:project"
47-
maxAge = "60s"
48-
[caches.images]
49-
dir = ":cacheDir/_images"
50-
maxAge = -1
51-
[caches.modules]
52-
dir = ":cacheDir/modules"
53-
maxAge = -1
41+
caches:
42+
assets:
43+
dir: ':cacheDir/_gen'
44+
maxAge: -1
45+
getcsv:
46+
dir: ':cacheDir/:project'
47+
maxAge: 60s
48+
getjson:
49+
dir: ':cacheDir/:project'
50+
maxAge: 60s
51+
images:
52+
dir: ':cacheDir/_images'
53+
maxAge: -1
54+
modules:
55+
dir: ':cacheDir/modules'
56+
maxAge: -1
5457

5558
# Language configuration
5659

57-
[languages]
58-
[languages.en]
59-
title = "Kubernetes Contributors"
60-
languageName ="English"
60+
languages:
61+
en:
62+
title: Kubernetes Contributors
63+
languageName: English
6164

62-
[markup]
63-
[markup.goldmark]
64-
[markup.goldmark.renderer]
65-
unsafe = true
65+
markup:
66+
goldmark:
67+
renderer:
68+
unsafe: true
6669

67-
68-
[frontmatter]
69-
date = ["date", ":filename", "publishDate", "lastmod"]
70+
frontmatter:
71+
date:
72+
- date
73+
- ':filename'
74+
- publishDate
75+
- lastmod
7076

7177
# Everything below this are Site Params
72-
[params]
73-
copyright = "The Kubernetes Authors"
74-
privacy_policy = ""
78+
params:
79+
copyright: The Kubernetes Authors
80+
privacy_policy: ''
7581

7682
# First one is picked as the Twitter card image if not set on page.
77-
# images = ["images/project-illustration.png"]
83+
# images:
84+
# - "images/project-illustration.png"
7885

7986
# Menu title if your navbar has a versions selector to access old versions of your site.
8087
# This menu appears only if you have at least one [params.versions] set.
81-
version_menu = "Releases"
88+
version_menu: Releases
8289

8390
# Flag used in the "version-banner" partial to decide whether to display a
8491
# banner on every page indicating that this is an archived version of the docs.
8592
# Set this flag to "true" if you want to display the banner.
86-
archived_version = false
93+
archived_version: false
8794

8895
# The version number for the version of the docs represented in this doc set.
8996
# Used in the "version-banner" partial to display a version number for the
9097
# current doc set.
91-
version = "0.0"
98+
version: '0.0'
9299

93100
# A link to latest version of the docs. Used in the "version-banner" partial to
94101
# point people to the main doc site.
95-
# url_latest_version = "https://example.com"
102+
# url_latest_version: "https://example.com"
96103

97104
# Repository configuration (URLs for in-page links to opening issues and suggesting changes)
98-
# mgithub_repo = "https://github.com/kubernetes-sigs/contributor-site"
105+
# mgithub_repo: "https://github.com/kubernetes-sigs/contributor-site"
99106
# An optional link to a related project repo. For example, the sibling repository where your product code lives.
100-
#github_project_repo = "https://github.com/google/docsy"
107+
# github_project_repo: "https://github.com/google/docsy"
101108

102109
# Specify a value here if your content directory is not in your repo's root directory
103-
# github_subdir = ""
110+
# github_subdir: ""
104111

105112
# Google Custom Search Engine ID. Remove or comment out to disable search.
106-
gcs_engine_id = "8ad0f1b8442fece81"
113+
gcs_engine_id: 8ad0f1b8442fece81
107114

108115
# Enable Algolia DocSearch
109-
algolia_docsearch = false
116+
algolia_docsearch: false
110117

111118
# Enable Lunr.js offline search
112-
offlineSearch = false
119+
offlineSearch: false
113120

114121
# User interface configuration
115-
[params.ui]
122+
ui:
116123
# Enable to show the side bar menu in its compact state.
117-
sidebar_menu_compact = true
124+
sidebar_menu_compact: true
118125
# Set to true to disable breadcrumb navigation.
119-
breadcrumb_disable = false
126+
breadcrumb_disable: false
120127
# Set to true to hide the sidebar search box (the top nav search box will still be displayed if search is enabled)
121-
sidebar_search_disable = false
128+
sidebar_search_disable: false
122129
# Set to false if you don't want to display a logo (/assets/icons/logo.svg) in the top nav bar
123-
navbar_logo = true
130+
navbar_logo: true
124131
# Set to true to disable the About link in the site footer
125-
footer_about_disable = false
132+
footer_about_disable: false
126133

127134
# Adds a H2 section titled "Feedback" to the bottom of each doc. The responses are sent to Google Analytics as events.
128135
# This feature depends on [services.googleAnalytics] and will be disabled if "services.googleAnalytics.id" is not set.
129136
# If you want this feature, but occasionally need to remove the "Feedback" section from a single page,
130137
# add "hide_feedback: true" to the page's front matter.
131-
[params.ui.feedback]
132-
enable = true
138+
feedback:
139+
enable: true
133140
# The responses that the user sees after clicking "yes" (the page was helpful) or "no" (the page was not helpful).
134141
# yes = 'Glad to hear it! Please <a href="https://github.com/USERNAME/REPOSITORY/issues/new">tell us how we can improve</a>.'
135-
#no = 'Sorry to hear that. Please <a href="https://github.com/USERNAME/REPOSITORY/issues/new">tell us how we can improve</a>.'
136-
137-
[params.links]
142+
# no = 'Sorry to hear that. Please <a href="https://github.com/USERNAME/REPOSITORY/issues/new">tell us how we can improve</a>.'
143+
144+
links:
138145
# End user relevant links. These will show up on left side of footer and in the community page if you have one.
139-
[[params.links.user]]
140-
name = "Kubernetes Dev Mailing List"
141-
url = "https://groups.google.com/a/kubernetes.io/group/dev"
142-
icon = "fa fa-envelope"
143-
desc = "Discussion and help from your fellow users"
144-
[[params.links.user]]
145-
name ="Twitter"
146-
url = "https://twitter.com/K8sContributors"
147-
icon = "fab fa-twitter"
148-
desc = "Follow us on Twitter to get the latest news!"
146+
user:
147+
- name: Kubernetes Dev Mailing List
148+
url: 'https://groups.google.com/a/kubernetes.io/group/dev'
149+
icon: fa fa-envelope
150+
desc: Discussion and help from your fellow users
151+
- name: Twitter
152+
url: 'https://twitter.com/K8sContributors'
153+
icon: fab fa-twitter
154+
desc: Follow us on Twitter to get the latest news!
149155
# Developer relevant links. These will show up on right side of footer and in the community page if you have one.
150-
[[params.links.developer]]
151-
name = "GitHub"
152-
url = "https://github.com/kubernetes/community"
153-
icon = "fab fa-github"
154-
desc = "Home of the Kubernetes Community!"
155-
[[params.links.developer]]
156-
name = "Slack"
157-
url = "https://slack.k8s.io"
158-
icon = "fab fa-slack"
159-
desc = "Chat with other project developers"
156+
developer:
157+
- name: GitHub
158+
url: 'https://github.com/kubernetes/community'
159+
icon: fab fa-github
160+
desc: Home of the Kubernetes Community!
161+
- name: Slack
162+
url: 'https://slack.k8s.io'
163+
icon: fab fa-slack
164+
desc: Chat with other project developers

0 commit comments

Comments
 (0)