Skip to content

Commit 2aef956

Browse files
authored
Update 0.14 release notes, Hugo upgrade guide, style adjustments, and more (#2502)
1 parent 061b376 commit 2aef956

34 files changed

+970
-367
lines changed

.vscode/cspell.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
"caseSensitive": true,
55
"words": [
66
"anchorize",
7+
"chalin",
8+
"CNCF",
79
"docset",
810
"docsets",
911
"Docsy",
@@ -15,10 +17,12 @@
1517
"htmltest",
1618
"hugo",
1719
"isset",
20+
"lastmod",
1821
"markdownify",
1922
"navbars",
2023
"nvmrc",
2124
"Occitan",
25+
"pageinfo",
2226
"refcache",
2327
"relref",
2428
"scrollspy",

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
11
# Docsy
22

3-
> **🚧 WARNING 🚧 : `main` is under development and potentially unstable! Use
4-
> official Docsy [releases].**
5-
63
Docsy is a [Hugo](https://gohugo.io) theme for technical documentation sets,
74
providing simple navigation, site structure, and more.
85

96
This is not an officially supported Google product. This project is actively
107
being maintained.
118

9+
> [!IMPORTANT] 🚧 IMPORTANT 🚧
10+
>
11+
> The `main` branch is under development and not officially supported; use
12+
> official Docsy [releases]. For full support details, see [Official support
13+
> limits][official-support].
14+
1215
## Prerequisites
1316

1417
The following are basic prerequisites for using Docsy in your site:
@@ -103,6 +106,11 @@ This project is licensed under the Apache License 2.0, see
103106
[deploys]: https://app.netlify.com/sites/docsydocs/deploys
104107
[main-preview]: https://main--docsydocs.netlify.app/
105108
[netlify]: https://netlify.com
109+
110+
<!-- FIXME: once 0.14.0 is released, update the link to the changelog page -->
111+
112+
[official-support]:
113+
https://www.docsy.dev/blog/2024/0.10.0/#hugo-breaking-changes-and-deprecation-notices
106114
[releases]: https://github.com/google/docsy/releases
107115

108116
<!-- cSpell:ignore docsy -->

assets/scss/td/_content.scss

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,16 @@
8383
margin-bottom: 2 * $spacer;
8484
}
8585

86+
details {
87+
&:not(:last-child) {
88+
margin-bottom: $spacer;
89+
}
90+
91+
> p:first-of-type {
92+
margin-top: $spacer;
93+
}
94+
}
95+
8696
.lead {
8797
margin-bottom: 1.5rem;
8898
}

assets/scss/td/_sidebar-toc.scss

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,7 @@
7878
}
7979

8080
#TableOfContents {
81+
--td-toc-h1-font-weight-delta: 200;
8182
margin-left: -0.75rem;
8283

8384
a {
@@ -101,6 +102,12 @@
101102
}
102103
}
103104

105+
> ul > li > :not(ul) {
106+
font-weight: calc(
107+
var(--bs-body-font-weight, 400) + var(--td-toc-h1-font-weight-delta)
108+
);
109+
}
110+
104111
ul ul a {
105112
padding-left: $toc-padding-base + $toc-padding-increment;
106113
}

assets/scss/td/extra/_index.scss

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,21 @@
22
// eventually be merged into the core Docsy theme.
33

44
@import 'navbar';
5+
6+
// Margin fix for nested lists [EXPERIMENTAL]
7+
8+
body {
9+
// --td-nested-lists-last-item-margin: initial;
10+
11+
&:not(.td-disable-nested-lists-last-item-margin) {
12+
.td-content {
13+
--td-nested-lists-last-item-margin: 1rem;
14+
15+
li > ul {
16+
> li:last-child {
17+
margin-bottom: var(--td-nested-lists-last-item-margin);
18+
}
19+
}
20+
}
21+
}
22+
}

assets/scss/td/main.scss

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,9 @@
5656
h2[id]::before,
5757
h3[id]::before,
5858
h4[id]::before,
59-
h5[id]::before {
59+
h5[id]::before,
60+
h6[id]::before,
61+
.td-offset-anchor::before {
6062
$td-anchor-offset-delta: 1.5rem;
6163
display: block;
6264
content: ' ';

docsy.dev/content/en/blog/2023/0.7.x.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ author: >
77
[Docsy Steering Committee](/blog/2022/hello/#introducing-the-psc))
88
date: 2023-08-03
99
aliases: [docsy-0.7]
10-
cSpell:ignore: CNCF Chalin opentelemetry namespacing docsy
10+
cSpell:ignore: opentelemetry namespacing docsy
1111
---
1212

1313
Last June, Docsy celebrated a significant milestone with the release of version

docsy.dev/content/en/blog/2023/bootstrap-5-migration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ author: >
99
[Docsy Steering Committee](/blog/2022/hello/#introducing-the-psc))
1010
date: 2023-06-05
1111
canonical_url: https://www.cncf.io/blog/2023/06/05/migrating-docsy-to-bootstrap-5/
12-
cSpell:ignore: CNCF Chalin opentelemetry techdocs
12+
cSpell:ignore: opentelemetry techdocs
1313
---
1414

1515
[Docsy](https://docsy.dev), and Docsy-based project websites ([including those

docsy.dev/content/en/blog/2023/priorities-for-2024.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ author: >
66
for the [Docsy Steering Committee](/blog/2022/hello/#introducing-the-psc)
77
date: 2023-11-28
88
# prettier-ignore
9-
cSpell:ignore: CNCF Chalin opentelemetry namespacing docsy customizability deprioritize
9+
cSpell:ignore: opentelemetry namespacing docsy customizability deprioritize
1010
---
1111

1212
> **TL;DR** 1.4K projects use Docsy! The top user-project focused priorities for

docsy.dev/content/en/blog/2024/0.10.0.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,9 @@ author: >
55
[Patrice Chalin](https://github.com/chalin) ([CNCF](https://www.cncf.io/)),
66
for the [Docsy Steering Committee](/blog/2022/hello/#introducing-the-psc)
77
date: 2024-05-01
8+
lastmod: 2026-01-31
89
# prettier-ignore
9-
cSpell:ignore: CNCF Chalin subdir deprecat upvoted pageinfo lookandfeel lightdark
10+
cSpell:ignore: subdir deprecat upvoted pageinfo lookandfeel lightdark
1011
---
1112

1213
The big news with Docsy [0.10.0] is color themes and dark mode!
@@ -21,14 +22,10 @@ this Docsy version, review Hugo's deprecation notices and breaking changes since
2122

2223
[0.123.0]: https://github.com/gohugoio/hugo/releases/tag/v0.123.0
2324

24-
> [!NOTE] Hugo version support reminder
25+
> [!IMPORTANT] Reminder
2526
>
26-
> Each Docsy version officially **only** supports the Hugo version specified in
27-
> the project's [package.json] entry for [hugo-extended]. Any other
28-
> compatibility is on a best effort basis.
29-
>
30-
> [hugo-extended]: https://github.com/jakejarvis/hugo-extended
31-
> [package.json]: https://github.com/google/docsy/blob/main/package.json
27+
> For the official support limits for Docsy and its peer packages, see
28+
> [Official support limits](/project/about/changelog/#official-support).
3229
3330
A number of updates to this release were to address Hugo's deprecation notices.
3431
For the complete list, search for [0.10.0] release changes with "deprecat" in

0 commit comments

Comments
 (0)