Skip to content

Commit 11d3dc3

Browse files
committed
fixed mermaid in relevant pages
1 parent 5a6b43f commit 11d3dc3

File tree

29 files changed

+394
-405
lines changed

29 files changed

+394
-405
lines changed

README.md

+1-20
Original file line numberDiff line numberDiff line change
@@ -100,28 +100,9 @@ news_link: 'https://google.com'
100100

101101
## Mermaid
102102

103-
Mermaid is loaded into content pages only when the boolean frontmatter variable `mermaid` is set to `true`.
103+
The Docsy theme supports Mermaid diagrams. See https://www.docsy.dev/docs/adding-content/diagrams-and-formulae/#diagrams-with-mermaid
104104

105-
1. Use the `mermaid` shortcode to make sure your graph isn't processed as markdown:
106105

107-
```
108-
{{< mermaid >}}
109-
graph TB
110-
111-
clouddriver(Clouddriver) --> clouddriver-caching(Clouddriver-Caching);
112-
clouddriver --> clouddriver-rw(Clouddriver-RW);
113-
clouddriver --> clouddriver-ro(Clouddriver-RO);
114-
clouddriver --> clouddriver-ro-deck(Clouddriver-RO-Deck)
115-
116-
classDef default fill:#d8e8ec,stroke:#39546a;
117-
linkStyle default stroke:#39546a,stroke-width:1px,fill:none;
118-
119-
classDef split fill:#42f4c2,stroke:#39546a;
120-
class clouddriver-caching,clouddriver-ro,clouddriver-ro-deck,clouddriver-rw,echo-scheduler,echo-worker split
121-
{{< /mermaid >}}
122-
```
123-
124-
2. Add the frontmatter variable to the page: `mermaid: true`.
125106

126107
## Custom YouTube Shortcode
127108

assets/scss/_styles_project.scss

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
@import 'homepage-hero';
44
@import 'slick-theme';
55
@import 'slick';
6-
@import 'docs';
76
@import 'navbar';
87

8+
99
h3 {
1010
margin-bottom: 1.6rem;
1111
}

assets/scss/docs.scss

-25
This file was deleted.

assets/scss/navbar.scss

+2
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@
1414
margin-left: 15px;
1515
}
1616
}
17+
18+
1719
.navbar-expand .navbar-nav .nav-link {
1820
padding-right: 1rem;
1921
padding-left: 1rem;

config.toml

+113-112
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,72 @@
11
baseURL = "/"
2-
title = "Spinnaker"
32

43
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
516

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.
718
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"
822

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"
1170

1271
# Language settings
1372
contentDir = "content/en"
@@ -18,50 +77,25 @@ enableMissingTranslationPlaceholders = true
1877

1978
disableKinds = ["taxonomy", "taxonomyTerm"]
2079

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)
2290
pygmentsCodeFences = true
2391
pygmentsUseClasses = false
2492
# Use the new Chroma Go highlighter in Hugo.
2593
pygmentsUseClassic = false
2694
#pygmentsOptions = "linenos=table"
2795
# 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"
6297

6398
[markup]
64-
defaultMarkdownHandler = "goldmark"
6599
[markup.goldmark]
66100
[markup.goldmark.renderer]
67101
unsafe = true
@@ -76,20 +110,41 @@ defaultMarkdownHandler = "goldmark"
76110
attribute = true
77111
autoHeadingID = true
78112
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
89113
[markup.tableOfContents]
90114
endLevel = 3
91115
ordered = false
92116
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+
93148
# Everything below this are Site Params
94149
[params]
95150
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
111166
# The version number for the version of the docs represented in this doc set.
112167
# Used in the "version-banner" partial to display a version number for the
113168
# current doc set.
114-
version = "v1.19"
169+
version = "Latest"
115170

116171
# A link to latest version of the docs. Used in the "version-banner" partial to
117172
# point people to the main doc site.
118-
url_latest_version = "https://example.com"
173+
url_latest_version = "https://spinnaker.io/docs/"
119174

120175
# Repository configuration (URLs for in-page links to opening issues and suggesting changes)
121176
github_repo = "https://github.com/spinnaker/spinnaker.io"
122177
# An optional link to a related project repo. For example, the sibling repository where your product code lives.
123178
github_project_repo = "https://github.com/spinnaker/spinnaker"
124179

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-
131180
# Enable Algolia DocSearch
132181
algolia_docsearch = false
133182

134183
# Enable Lunr.js offline search
135184
offlineSearch = true
185+
offlineSearchMaxResults = 50
186+
offlineSearchSummaryLength = 200
136187

137188
# Promo Banner variables
138189
[params.promoBanner]
@@ -148,6 +199,8 @@ offlineSearch = true
148199
[params.ui]
149200
# Enable to show the side bar menu in its compact state.
150201
sidebar_menu_compact = true
202+
sidebar_menu_foldable= true
203+
sidebar_cache_limit = 10
151204
# Set to true to disable breadcrumb navigation.
152205
breadcrumb_disable = false
153206
# 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
165218
[params.ui.feedback]
166219
enable = false
167220
# 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>.'
170223

171224
# Adds a reading time to the top of each doc.
172225
# If you want this feature, but occasionally need to remove the Reading time from a single page,
@@ -230,55 +283,3 @@ enable = false
230283
weight = 50
231284
url = "https://github.com/spinnaker"
232285
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/"

content/en/_index.md

+2
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,5 @@ contrib_text:
1818
who_should_use_header: 'Who should use Spinnaker?'
1919
who_should_use_text: 'Spinnaker provides application management and deployment to help you release software changes with high velocity and confidence. Spinnaker is an open-source, multi-cloud continuous delivery platform that combines a powerful and flexible pipeline management system with integrations to the major cloud providers. If you are looking to standardize your release processes and improve quality, Spinnaker is for you. '
2020
---
21+
22+
{{% promoBanner %}}

0 commit comments

Comments
 (0)