Skip to content

Commit 2e609f3

Browse files
kaxilkaxil
committed
Fix CSS generation for Docsy v0.12.0 upgrade
When upgrading from Docsy v0.2.0-pre to v0.12.0, custom CSS (main-custom.scss) was not being generated, causing styling issues. Root cause: - Docsy v0.12.0 added layouts/_partials/head.html which uses partialCached - Hugo's partial lookup prioritizes theme's _partials over site's partials - Our custom CSS processing in head-end.html hook wasn't being called Fixes: 1. Add layouts/_partials/head.html to override Docsy's head partial 2. Add layouts/_partials/head-css.html (partials must exist in same directory) 3. Move main-custom.scss processing from head-end hook to head-css partial 4. Remove partialCached from head.html to ensure CSS is always generated 5. Configure PostCSS to skip external font URLs Verified: - Both main.min.*.css and main-custom.min.*.css are generated - Light and dark modes work correctly - prepare-theme step succeeds
1 parent 21f439b commit 2e609f3

File tree

6 files changed

+103
-13
lines changed

6 files changed

+103
-13
lines changed

‎landing-pages/postcss.config.js‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,12 @@
1919

2020
module.exports = {
2121
plugins: {
22-
"postcss-import": {},
22+
"postcss-import": {
23+
// Don't inline @import url() statements - leave them for the browser
24+
filter: (path) => {
25+
return !/^https?:\/\//.test(path) && !path.startsWith('/external/');
26+
}
27+
},
2328
"postcss-preset-env": {
2429
browsers: "last 2 versions"
2530
},

‎landing-pages/site/layouts/_partials/head-css.html‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
{{/*
2+
Licensed to the Apache Software Foundation (ASF) under one
3+
or more contributor license agreements. See the NOTICE file
4+
distributed with this work for additional information
5+
regarding copyright ownership. The ASF licenses this file
6+
to you under the Apache License, Version 2.0 (the
7+
"License"); you may not use this file except in compliance
8+
with the License. You may obtain a copy of the License at
9+
10+
http://www.apache.org/licenses/LICENSE-2.0
11+
12+
Unless required by applicable law or agreed to in writing,
13+
software distributed under the License is distributed on an
14+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
KIND, either express or implied. See the License for the
16+
specific language governing permissions and limitations
17+
under the License.
18+
*/}}
19+
{{/* Process Docsy's main stylesheet */}}
20+
{{ $scssMain := "scss/main.scss"}}
21+
{{ if hugo.IsServer }}
22+
{{/* Note the missing postCSS. This makes it snappier to develop in Chrome, but makes it look suboptimal in other browsers. */}}
23+
{{ $css := resources.Get $scssMain | toCSS (dict "enableSourceMap" true) }}
24+
<link href="{{ $css.RelPermalink }}" rel="stylesheet">
25+
{{ else }}
26+
{{ $css := resources.Get $scssMain | toCSS (dict "enableSourceMap" false) | postCSS | minify | fingerprint }}
27+
<link rel="preload" href="{{ $css.RelPermalink }}" as="style">
28+
<link href="{{ $css.RelPermalink }}" rel="stylesheet" integrity="{{ $css.Data.integrity }}">
29+
{{ end }}
30+
31+
{{/* Process our custom stylesheet for landing pages */}}
32+
{{ $scssCustom := "scss/main-custom.scss"}}
33+
{{ $customScssResource := resources.Get $scssCustom }}
34+
{{ if hugo.IsServer }}
35+
{{ $cssCustom := $customScssResource | toCSS (dict "enableSourceMap" true) | postCSS }}
36+
<link href="{{ $cssCustom.RelPermalink }}" rel="stylesheet">
37+
{{ else }}
38+
{{ $cssCustom := $customScssResource | toCSS (dict "enableSourceMap" false) | postCSS | minify | fingerprint }}
39+
<link rel="preload" href="{{ $cssCustom.RelPermalink }}" as="style">
40+
<link href="{{ $cssCustom.RelPermalink }}" rel="stylesheet" integrity="{{ $cssCustom.Data.integrity }}">
41+
{{ end }}

‎landing-pages/site/layouts/_partials/head.html‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
{{/*
2+
Licensed to the Apache Software Foundation (ASF) under one
3+
or more contributor license agreements. See the NOTICE file
4+
distributed with this work for additional information
5+
regarding copyright ownership. The ASF licenses this file
6+
to you under the Apache License, Version 2.0 (the
7+
"License"); you may not use this file except in compliance
8+
with the License. You may obtain a copy of the License at
9+
10+
http://www.apache.org/licenses/LICENSE-2.0
11+
12+
Unless required by applicable law or agreed to in writing,
13+
software distributed under the License is distributed on an
14+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
KIND, either express or implied. See the License for the
16+
specific language governing permissions and limitations
17+
under the License.
18+
*/}}
19+
<meta charset="{{ .Site.Params.charset }}">
20+
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
21+
{{ hugo.Generator }}
22+
{{ if eq (getenv "HUGO_ENV") "production" }}
23+
<META NAME="ROBOTS" CONTENT="INDEX, FOLLOW">
24+
{{ else }}
25+
<META NAME="ROBOTS" CONTENT="NOINDEX, NOFOLLOW">
26+
{{ end }}
27+
{{ range .AlternativeOutputFormats -}}
28+
<link rel="{{ .Rel }}" type="{{ .MediaType.Type }}" href="{{ .Permalink | safeURL }}">
29+
{{ end -}}
30+
{{ partialCached "favicons.html" . }}
31+
<title>{{ if .IsHome }}{{ .Site.Title }}{{ else }}{{ with .Title }}{{ . }} | {{ end }}{{ .Site.Title }}{{ end }}</title>
32+
{{- template "_internal/opengraph.html" . -}}
33+
{{- template "_internal/schema.html" . -}}
34+
{{ if eq (getenv "HUGO_ENV") "production" }}
35+
{{ template "_internal/google_analytics.html" . }}
36+
{{ end }}
37+
{{ partial "head-css.html" . }}
38+
<script
39+
src="/external/js/jquery-3.3.1.min.js"
40+
integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8="
41+
crossorigin="anonymous"></script>
42+
{{ partial "hooks/head-end.html" . }}

‎landing-pages/site/layouts/partials/head-css.html‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
specific language governing permissions and limitations
1717
under the License.
1818
*/}}
19+
{{/* Process Docsy's main stylesheet */}}
1920
{{ $scssMain := "scss/main.scss"}}
2021
{{ if hugo.IsServer }}
2122
{{/* Note the missing postCSS. This makes it snappier to develop in Chrome, but makes it look suboptimal in other browsers. */}}
@@ -26,3 +27,15 @@
2627
<link rel="preload" href="{{ $css.RelPermalink }}" as="style">
2728
<link href="{{ $css.RelPermalink }}" rel="stylesheet" integrity="{{ $css.Data.integrity }}">
2829
{{ end }}
30+
31+
{{/* Process our custom stylesheet for landing pages */}}
32+
{{ $scssCustom := "scss/main-custom.scss"}}
33+
{{ $customScssResource := resources.Get $scssCustom }}
34+
{{ if hugo.IsServer }}
35+
{{ $cssCustom := $customScssResource | toCSS (dict "enableSourceMap" true) | postCSS }}
36+
<link href="{{ $cssCustom.RelPermalink }}" rel="stylesheet">
37+
{{ else }}
38+
{{ $cssCustom := $customScssResource | toCSS (dict "enableSourceMap" false) | postCSS | minify | fingerprint }}
39+
<link rel="preload" href="{{ $cssCustom.RelPermalink }}" as="style">
40+
<link href="{{ $cssCustom.RelPermalink }}" rel="stylesheet" integrity="{{ $cssCustom.Data.integrity }}">
41+
{{ end }}

‎landing-pages/site/layouts/partials/head.html‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@
1616
specific language governing permissions and limitations
1717
under the License.
1818
*/}}
19-
2019
<meta charset="{{ .Site.Params.charset }}">
2120
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
2221
{{ hugo.Generator }}
@@ -35,7 +34,7 @@
3534
{{ if eq (getenv "HUGO_ENV") "production" }}
3635
{{ template "_internal/google_analytics.html" . }}
3736
{{ end }}
38-
{{ partialCached "head-css.html" . "asdf" }}
37+
{{ partial "head-css.html" . }}
3938
<script
4039
src="/external/js/jquery-3.3.1.min.js"
4140
integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8="

‎landing-pages/site/layouts/partials/hooks/head-end.html‎

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -19,16 +19,6 @@
1919

2020
<meta name="description" content="{{ .Description | default $.Site.Params.description }}" />
2121

22-
{{ $scssMain := "scss/main-custom.scss"}}
23-
{{ if hugo.IsServer }}
24-
{{ $css := resources.Get $scssMain | toCSS (dict "enableSourceMap" true) | postCSS }}
25-
<link href="{{ $css.RelPermalink }}" rel="stylesheet">
26-
{{ else }}
27-
{{ $css := resources.Get $scssMain | toCSS (dict "enableSourceMap" false) | postCSS | minify | fingerprint }}
28-
<link rel="preload" href="{{ $css.RelPermalink }}" as="style">
29-
<link href="{{ $css.RelPermalink }}" rel="stylesheet" integrity="{{ $css.Data.integrity }}">
30-
{{ end }}
31-
3222
<!-- Matomo -->
3323
<script>
3424
var _paq = window._paq = window._paq || [];

0 commit comments

Comments
 (0)