1
1
baseURL = " /"
2
- title = " Spinnaker"
3
2
4
3
enableRobotsTXT = true
4
+ enableInlineShortcodes = true
5
+ # Will give values to .Lastmod etc.
6
+ enableGitInfo = true
7
+
8
+ # Language configuration
9
+ [languages ]
10
+ [languages .en ]
11
+ title = " Spinnaker"
12
+ description = " Spinnaker is an open source, multi-cloud continuous delivery platform for releasing software changes with high velocity and confidence."
13
+ languageName =" English"
14
+ # Weight used for sorting.
15
+ weight = 1
5
16
6
- # Hugo allows theme composition (and inheritance). The precedence is from left to right.
17
+ # Docsy is now a Go module. Hugo allows theme composition (and inheritance). The precedence is from left to right.
7
18
theme = [" github.com/google/docsy" , " github.com/google/docsy/dependencies" ]
19
+ # Sept 2023 If I don't include module.imports.mounts entries, compilation breaks with a lot of "not found" - can't find shortcodes or refs
20
+ [module ]
21
+ proxy = " direct"
8
22
9
- # Will give values to .Lastmod etc.
10
- enableGitInfo = true
23
+ [module .hugoVersion ]
24
+ extended = true
25
+ min = " 0.110.0"
26
+
27
+ [[module .imports ]]
28
+ path = " github.com/google/docsy"
29
+ disable = false
30
+
31
+ [[module .imports .mounts ]]
32
+ source = " assets"
33
+ target = " assets"
34
+
35
+ [[module .imports .mounts ]]
36
+ source = " node_modules/bootstrap"
37
+ target = " assets/vendor/bootstrap"
38
+
39
+ [[module .imports .mounts ]]
40
+ source = " node_modules/@fortawesome/fontawesome-free"
41
+ target = " assets/vendor/Font-Awesome"
42
+
43
+ [[module .imports .mounts ]]
44
+ source = " i18n"
45
+ target = " i18n"
46
+
47
+ [[module .imports .mounts ]]
48
+ source = " layouts"
49
+ target = " layouts"
50
+
51
+ [[module .imports .mounts ]]
52
+ source = " static"
53
+ target = " static"
54
+
55
+ [[module .imports .mounts ]]
56
+ source = " data"
57
+ target = " data"
58
+
59
+ [[module .imports .mounts ]]
60
+ source = " node_modules/@fortawesome/fontawesome-free/webfonts"
61
+ target = " static/webfonts"
62
+
63
+ [[module .imports ]]
64
+ path = " github.com/google/docsy/dependencies"
65
+ disable = false
66
+
67
+ [[module .mounts ]]
68
+ source = " content/en"
69
+ target = " content"
11
70
12
71
# Language settings
13
72
contentDir = " content/en"
@@ -18,50 +77,25 @@ enableMissingTranslationPlaceholders = true
18
77
19
78
disableKinds = [" taxonomy" , " taxonomyTerm" ]
20
79
21
- # Highlighting config
80
+ # Google Analytics configuration
81
+ # https://gohugo.io/templates/internal/#configure-google-analytics
82
+ # https://www.docsy.dev/docs/adding-content/feedback/#adding-analytics
83
+ googleAnalytics = " G-H0XE7ESBFR"
84
+
85
+ # Configure how URLs look like per section.
86
+ [permalinks ]
87
+ blog = " /:section/:year/:month/:day/:slug/"
88
+
89
+ # Highlighting config (copied from the docsy example site, tag v0.7.1)
22
90
pygmentsCodeFences = true
23
91
pygmentsUseClasses = false
24
92
# Use the new Chroma Go highlighter in Hugo.
25
93
pygmentsUseClassic = false
26
94
# pygmentsOptions = "linenos=table"
27
95
# See https://help.farbox.com/pygments.html
28
- pygmentsStyle = " tango"
29
-
30
- # Configure how URLs look like per section.
31
- [permalinks ]
32
- blog = " /:section/:year/:month/:day/:slug/"
33
-
34
- # # Configuration for BlackFriday markdown parser: https://github.com/russross/blackfriday
35
- # [blackfriday]
36
- # plainIDAnchors = true
37
- # hrefTargetBlank = true
38
- # angledQuotes = false
39
- # latexDashes = true
40
-
41
- # Image processing configuration.
42
- [imaging ]
43
- resampleFilter = " CatmullRom"
44
- quality = 75
45
- anchor = " smart"
46
-
47
- [services ]
48
- [services .googleAnalytics ]
49
- # Comment out the next line to disable GA tracking. Also disables the feature described in [params.ui.feedback].
50
- # This ID can be found in Google Analytics -> Admin Panel -> Data Streams -> Spinnaker Website - GA4 -> Measurement ID
51
- id = " G-H0XE7ESBFR"
52
-
53
- # Language configuration
54
-
55
- [languages ]
56
- [languages .en ]
57
- title = " Spinnaker"
58
- description = " Multi-cloud continuous delivery for the enterprise"
59
- languageName =" English"
60
- # Weight used for sorting.
61
- weight = 1
96
+ pygmentsStyle = " dracula"
62
97
63
98
[markup ]
64
- defaultMarkdownHandler = " goldmark"
65
99
[markup .goldmark ]
66
100
[markup .goldmark .renderer ]
67
101
unsafe = true
@@ -76,20 +110,41 @@ defaultMarkdownHandler = "goldmark"
76
110
attribute = true
77
111
autoHeadingID = true
78
112
autoHeadingIDType = " github"
79
- [markup .highlight ]
80
- codeFences = true
81
- guessSyntax = false
82
- hl_Lines = " "
83
- lineNoStart = 1
84
- lineNos = false
85
- lineNumbersInTable = true
86
- noClasses = true
87
- style = " monokai"
88
- tabWidth = 4
89
113
[markup .tableOfContents ]
90
114
endLevel = 3
91
115
ordered = false
92
116
startLevel = 2
117
+ [markup .highlight ]
118
+ # See a complete list of available styles at https://xyproto.github.io/splash/docs/all.html
119
+ style = " dracula"
120
+ # these are defaults https://gohugo.io/getting-started/configuration-markup/#highlight
121
+ anchorLineNos = false
122
+ codeFences = true
123
+ hl_Lines = ' '
124
+ hl_inline = false
125
+ lineAnchors = ' '
126
+ lineNoStart = 1
127
+ lineNos = false
128
+ lineNumbersInTable = true
129
+ noClasses = true
130
+ noHl = false
131
+ tabWidth = 4
132
+ guessSyntax = true
133
+ # Set guessSyntax to true if you want your chosen highlight style used for code blocks without a specified language
134
+
135
+
136
+
137
+ # Image processing configuration.
138
+ [imaging ]
139
+ resampleFilter = " CatmullRom"
140
+ quality = 75
141
+ anchor = " smart"
142
+
143
+
144
+
145
+
146
+
147
+
93
148
# Everything below this are Site Params
94
149
[params ]
95
150
copyright = ' Copyright © 2020 The Linux Foundation®. All rights reserved. The Linux Foundation has registered trademarks and uses trademarks. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage">Trademark Usage</a> page. Linux is a registered trademark of Linus Torvalds.'
@@ -111,28 +166,24 @@ archived_version = false
111
166
# The version number for the version of the docs represented in this doc set.
112
167
# Used in the "version-banner" partial to display a version number for the
113
168
# current doc set.
114
- version = " v1.19 "
169
+ version = " Latest "
115
170
116
171
# A link to latest version of the docs. Used in the "version-banner" partial to
117
172
# point people to the main doc site.
118
- url_latest_version = " https://example.com "
173
+ url_latest_version = " https://spinnaker.io/docs/ "
119
174
120
175
# Repository configuration (URLs for in-page links to opening issues and suggesting changes)
121
176
github_repo = " https://github.com/spinnaker/spinnaker.io"
122
177
# An optional link to a related project repo. For example, the sibling repository where your product code lives.
123
178
github_project_repo = " https://github.com/spinnaker/spinnaker"
124
179
125
- # Specify a value here if your content directory is not in your repo's root directory
126
- # github_subdir = ""
127
-
128
- # Google Custom Search Engine ID. Remove or comment out to disable search.
129
- # gcs_engine_id = "011737558837375720776:fsdu1nryfng"
130
-
131
180
# Enable Algolia DocSearch
132
181
algolia_docsearch = false
133
182
134
183
# Enable Lunr.js offline search
135
184
offlineSearch = true
185
+ offlineSearchMaxResults = 50
186
+ offlineSearchSummaryLength = 200
136
187
137
188
# Promo Banner variables
138
189
[params .promoBanner ]
@@ -148,6 +199,8 @@ offlineSearch = true
148
199
[params .ui ]
149
200
# Enable to show the side bar menu in its compact state.
150
201
sidebar_menu_compact = true
202
+ sidebar_menu_foldable = true
203
+ sidebar_cache_limit = 10
151
204
# Set to true to disable breadcrumb navigation.
152
205
breadcrumb_disable = false
153
206
# Set to true to hide the sidebar search box (the top nav search box will still be displayed if search is enabled)
@@ -165,8 +218,8 @@ footer_about_disable = false
165
218
[params .ui .feedback ]
166
219
enable = false
167
220
# The responses that the user sees after clicking "yes" (the page was helpful) or "no" (the page was not helpful).
168
- yes = ' Glad to hear it! Please <a href="https://github.com/USERNAME/REPOSITORY /issues/new">tell us how we can improve</a>.'
169
- no = ' Sorry to hear that. Please <a href="https://github.com/USERNAME/REPOSITORY /issues/new">tell us how we can improve</a>.'
221
+ yes = ' Glad to hear it! Please <a href="https://github.com/spinnaker/spinnaker.io /issues/new">tell us how we can improve</a>.'
222
+ no = ' Sorry to hear that. Please <a href="https://github.com/spinnaker/spinnaker.io /issues/new">tell us how we can improve</a>.'
170
223
171
224
# Adds a reading time to the top of each doc.
172
225
# If you want this feature, but occasionally need to remove the Reading time from a single page,
@@ -230,55 +283,3 @@ enable = false
230
283
weight = 50
231
284
url = " https://github.com/spinnaker"
232
285
pre = " <i class='fab fa-github'></i>"
233
- # Add your release versions here
234
-
235
-
236
- # baseURL = "/"
237
- # languageCode = "en-us"
238
- # title = "Spinnaker"
239
- # disableKinds = ["taxonomy", "taxonomyTerm"]
240
- # theme = "docsy-master"
241
-
242
- # Settings for goldmark markdown processing
243
- # [markup]
244
- # [markup.goldmark]
245
- # [markup.goldmark.renderer]
246
- # unsafe = true
247
-
248
- # Image processing configuration.
249
- # [imaging]
250
- # resampleFilter = "CatmullRom" # use standard Box processor for now
251
- # quality = 75
252
- # anchor = "smart"
253
- # disableDate = false
254
- # disableLatLong = false
255
-
256
- # main menu
257
- # [[menu.main]]
258
- # name = "Home"
259
- # url = "/"
260
- # weight = 1
261
-
262
- # [[menu.main]]
263
- # name = "Getting Started"
264
- # url = "/en/getting-started/"
265
- # weight = 1
266
- #
267
- # [[menu.main]]
268
- # name = "Docs"
269
- # url = "/en/docs/"
270
- # weight = 2
271
- #
272
- # [[menu.main]]
273
- # name = "Community"
274
- # url = "/en/docs/community/"
275
- # weight = 3
276
- #
277
- # [[menu.main]]
278
- # name = "Blog"
279
- # url = "https://blog.spinnaker.io/"
280
- # weight = 4
281
- #
282
- # [permalinks]
283
- # post = "/:year/:month/:day/:slug/"
284
- # pages = "/:filename/"
0 commit comments