Skip to content

Commit 49e21d0

Browse files
chalinchalin
authored
Upgrade to Docsy 0.13.0 (#9)
1 parent 33c568e commit 49e21d0

File tree

9 files changed

+68
-53
lines changed

9 files changed

+68
-53
lines changed

‎.gitignore‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,13 @@ node_modules/
88
package-lock.json
99

1010
# Local scratch folder
11-
tmp/
11+
/tmp
1212

1313
# macOS
1414
.DS_Store
1515

16-
# Misc
17-
scripts/collector.yaml
18-
assets/jsconfig.json
16+
# Apps & services
1917
/.netlify
20-
21-
# VS Code
2218
/.vscode
19+
20+
# cSpell:ignore hugo

‎README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,5 @@ and Continuous Integration (CI) tooling, based on CNCF websites built with
1212
For a preview, see [cncf-docsy-starter.netlify.app].
1313

1414
[cncf-docsy-starter.netlify.app]: https://cncf-docsy-starter.netlify.app/
15+
16+
<!-- cSpell:ignore cncf docsy -->

‎assets/scss/_styles_project.scss‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
1+
@import 'td/color-adjustments-dark';
12
@import 'td/code-dark';
3+
@import 'td/gcs-search-dark';

‎content/en/docs/_index.md‎

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,11 @@
22
title: Documentation
33
linkTitle: Docs
44
menu: { main: { weight: 20 } }
5-
spelling: cSpell:disable # REMOVE this line
65
---
76

8-
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor
9-
incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis
10-
nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
11-
Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu
12-
fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in
13-
culpa qui officia deserunt mollit anim id est laborum.
7+
This is placeholder content. Replace it with your own content. Use this section
8+
to guide readers through your product or project. Start with quickstart steps,
9+
link to core concepts, and point to reference material for advanced use cases.
10+
Keep each page focused, practical, and easy to scan so new users can find
11+
answers quickly while experienced users can dive deeper when they need
12+
specifics.

‎content/en/docs/examples.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Examples
33
weight: 500
4-
description: THIS IS SAMPLE CONTENT
4+
description: Examples of Docsy projects
55
---
66

77
One of the best ways to see what Docsy can do, and learn how to configure a site

‎content/en/docs/get-started/_index.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
---
22
title: Get started
33
weight: 100
4-
# aliases: [/docs/getting-started/]
5-
description: THIS IS SAMPLE CONTENT
4+
description: Get started with Docsy in under 5 minutes!
65
---
76

87
As you saw in our introduction, Docsy is a [Hugo](https://gohugo.io) theme,

‎netlify.toml‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,13 @@ command = "npm run seq -- build:preview diff:check"
44

55
[context.production]
66
command = "npm run seq -- build:production diff:check"
7+
8+
[[headers]]
9+
for = "/*"
10+
[headers.values]
11+
X-Content-Type-Options = "nosniff"
12+
Referrer-Policy = "strict-origin-when-cross-origin"
13+
X-Frame-Options = "SAMEORIGIN"
14+
Content-Security-Policy = "frame-ancestors 'self';"
15+
16+
# cSpell:ignore nosniff sameorigin

‎package.json‎

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,11 @@
44
"_build": "npm run _hugo-dev --",
55
"_check:format": "npx prettier --check .",
66
"_check:links--warn": "npm run _check:links || (echo; echo 'WARNING: see link-checker output for issues.'; echo)",
7+
"_check:links:internal": "npm run _check:links -- HTMLTEST_ARGS='--skip-external'",
78
"_check:links": "make --keep-going check-links",
89
"_commit:public": "HASH=$(git rev-parse --short main); cd public && git add -A && git commit -m \"Site at $HASH\"",
910
"_diff:check": "git diff --name-only --exit-code",
11+
"_ensure:docsy-hugo-modules": "test -d node_modules/github.com || npm --prefix node_modules/docsy run postinstall",
1012
"_filename-error": "echo 'ERROR: the following files violate naming conventions; fix using: `npm run fix:filenames`'; echo; npm run -s _ls-bad-filenames; exit 1",
1113
"_filenames-to-kebab-case": "find assets content -name '*_*' ! -name '[_.]*' -exec sh -c 'mv \"$1\" \"${1//_/-}\"' _ {} \\;",
1214
"_hugo-dev": "npm run _hugo -- -e dev -DFE",
@@ -20,24 +22,27 @@
2022
"check:format": "npm run _check:format || (echo '[help] Run: npm run fix:format'; exit 1)",
2123
"check:links:internal": "HTMLTEST_ARGS='--skip-external' npm run _check:links",
2224
"check:links": "npm run _check:links",
25+
"check:spelling": "npx cspell --no-progress -c .cspell.yml content data 'layouts/**/*.md'",
2326
"clean": "rm -Rf public/",
2427
"diff:check": "npm run _diff:check || (echo; echo 'WARNING: the files above have not been committed'; echo)",
2528
"fix:filenames": "npm run _filenames-to-kebab-case",
2629
"fix:format": "npm run _check:format -- --write",
2730
"make:public": "git init public",
2831
"postbuild:preview": "npm run _check:links--warn",
2932
"postbuild:production": "npm run _check:links--warn",
33+
"postinstall": "test ! -d node_modules/docsy || npm run _ensure:docsy-hugo-modules",
3034
"precheck:links:all": "npm run build",
3135
"precheck:links": "npm run build",
3236
"seq": "bash -c 'for cmd in \"$@\"; do npm run $cmd || exit 1; done' - ",
3337
"serve": "npm run _serve",
3438
"test": "npm run check:format && npm run check:links",
35-
"update:pkgs": "npx npm-check-updates -u"
39+
"update:packages": "npx npm-check-updates --dep 'prod,dev,optional,peer' -u"
3640
},
3741
"devDependencies": {
3842
"autoprefixer": "^10.4.21",
3943
"cspell": "^9.0.2",
40-
"docsy": "github:google/docsy",
44+
"docsy": "google/docsy#semver:0.13.0",
45+
"hugo-extended": "^0.152.2",
4146
"postcss-cli": "^11.0.1",
4247
"prettier": "^3.5.3"
4348
},
@@ -47,13 +52,13 @@
4752
},
4853
"enginesComment": "Ensure that engines.node value stays consistent with the project's .nvmrc",
4954
"engines": {
50-
"node": "22.x"
55+
"node": ">=24"
5156
},
52-
"gitHubActionCacheKey": "2024-07-02 - change this key to force cache refresh",
57+
"gitHubActionCacheKey": "2026-02-06 - refresh cache for Docsy 0.13.0 and Hugo 0.152.2",
5358
"private": true,
5459
"prettier": {
5560
"proseWrap": "always",
5661
"singleQuote": true
5762
},
58-
"spelling": "cSpell:ignore docsy hugo HTMLTEST pkgs netlify precheck postbuild -"
63+
"spelling": "cSpell:ignore docsy hugo HTMLTEST netlify precheck postbuild -"
5964
}

‎static/refcache.json‎

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
{
22
"https://code.jquery.com/jquery-3.7.1.min.js": {
33
"StatusCode": 206,
4-
"LastSeen": "2024-12-09T04:37:45.255441-05:00"
4+
"LastSeen": "2026-02-06T17:17:02.950108-05:00"
55
},
66
"https://creativecommons.org/licenses/by/4.0": {
77
"StatusCode": 206,
8-
"LastSeen": "2024-12-09T04:38:06.930975-05:00"
8+
"LastSeen": "2026-02-06T17:17:03.380923-05:00"
99
},
1010
"https://git-scm.com/book/en/v2/Git-Tools-Submodules": {
1111
"StatusCode": 206,
12-
"LastSeen": "2024-12-09T04:38:12.180225-05:00"
12+
"LastSeen": "2026-02-06T17:17:04.955354-05:00"
1313
},
1414
"https://github.com/chalin/docsy-starter": {
1515
"StatusCode": 206,
@@ -28,83 +28,83 @@
2828
"LastSeen": "2024-12-09T04:38:01.622268-05:00"
2929
},
3030
"https://github.com/chalin/docsy-starter/issues/new": {
31-
"StatusCode": 200,
32-
"LastSeen": "2024-12-09T04:37:56.020733-05:00"
31+
"StatusCode": 206,
32+
"LastSeen": "2026-02-06T17:17:03.866844-05:00"
3333
},
3434
"https://github.com/chalin/docsy-starter/tree/main/content/en/blog/2024/hello.md": {
35-
"StatusCode": 200,
36-
"LastSeen": "2024-12-09T04:37:50.778118-05:00"
35+
"StatusCode": 206,
36+
"LastSeen": "2026-02-06T17:17:03.623228-05:00"
3737
},
3838
"https://github.com/chalin/docsy-starter/tree/main/content/en/blog/_index.md": {
39-
"StatusCode": 200,
40-
"LastSeen": "2024-12-09T04:37:50.98801-05:00"
39+
"StatusCode": 206,
40+
"LastSeen": "2026-02-06T17:17:03.594748-05:00"
4141
},
4242
"https://github.com/chalin/docsy-starter/tree/main/content/en/docs/_index.md": {
43-
"StatusCode": 200,
44-
"LastSeen": "2024-12-09T04:37:50.852517-05:00"
43+
"StatusCode": 206,
44+
"LastSeen": "2026-02-06T17:17:03.594646-05:00"
4545
},
4646
"https://github.com/chalin/docsy-starter/tree/main/content/en/docs/examples.md": {
47-
"StatusCode": 200,
48-
"LastSeen": "2024-12-09T04:37:50.855131-05:00"
47+
"StatusCode": 206,
48+
"LastSeen": "2026-02-06T17:17:03.606455-05:00"
4949
},
5050
"https://github.com/chalin/docsy-starter/tree/main/content/en/docs/get-started/_index.md": {
51-
"StatusCode": 200,
52-
"LastSeen": "2024-12-09T04:37:50.775662-05:00"
51+
"StatusCode": 206,
52+
"LastSeen": "2026-02-06T17:17:03.623297-05:00"
5353
},
5454
"https://github.com/cncf/foundation/blob/main/code-of-conduct.md": {
55-
"StatusCode": 200,
56-
"LastSeen": "2024-12-09T04:38:12.051524-05:00"
55+
"StatusCode": 206,
56+
"LastSeen": "2026-02-06T17:17:03.666208-05:00"
5757
},
5858
"https://github.com/google/docsy": {
59-
"StatusCode": 200,
60-
"LastSeen": "2024-12-09T04:38:06.575012-05:00"
59+
"StatusCode": 206,
60+
"LastSeen": "2026-02-06T17:17:04.714173-05:00"
6161
},
6262
"https://github.com/google/docsy-example": {
63-
"StatusCode": 200,
64-
"LastSeen": "2024-12-09T04:38:07.017743-05:00"
63+
"StatusCode": 206,
64+
"LastSeen": "2026-02-06T17:17:04.79192-05:00"
6565
},
6666
"https://github.com/google/docsy/discussions": {
6767
"StatusCode": 200,
6868
"LastSeen": "2024-12-09T04:37:51.142969-05:00"
6969
},
7070
"https://github.com/google/docsy/pulls": {
71-
"StatusCode": 200,
72-
"LastSeen": "2024-12-09T04:37:56.351769-05:00"
71+
"StatusCode": 206,
72+
"LastSeen": "2026-02-06T17:17:04.12999-05:00"
7373
},
7474
"https://gohugo.io": {
7575
"StatusCode": 206,
76-
"LastSeen": "2024-12-09T04:38:01.557926-05:00"
76+
"LastSeen": "2026-02-06T17:17:04.060212-05:00"
7777
},
7878
"https://gohugo.io/hugo-modules/": {
7979
"StatusCode": 206,
80-
"LastSeen": "2024-12-09T04:38:06.314812-05:00"
80+
"LastSeen": "2026-02-06T17:17:04.172438-05:00"
8181
},
8282
"https://groups.google.com/forum/#!forum/docsy-users": {
8383
"StatusCode": 200,
84-
"LastSeen": "2024-12-09T04:37:56.329733-05:00"
84+
"LastSeen": "2026-02-06T17:17:03.06888-05:00"
8585
},
8686
"https://netlify.com": {
8787
"StatusCode": 206,
88-
"LastSeen": "2024-12-09T04:38:16.694228-05:00"
88+
"LastSeen": "2026-02-06T17:17:04.818308-05:00"
8989
},
9090
"https://stackoverflow.com/questions/tagged/docsy": {
9191
"StatusCode": 200,
92-
"LastSeen": "2024-12-09T04:38:01.499382-05:00"
92+
"LastSeen": "2026-02-06T17:17:03.273928-05:00"
9393
},
9494
"https://www.docsy.dev//docs/updating/convert-site-to-module/": {
9595
"StatusCode": 206,
96-
"LastSeen": "2024-12-09T04:38:17.553663-05:00"
96+
"LastSeen": "2026-02-06T17:17:05.318678-05:00"
9797
},
9898
"https://www.linuxfoundation.org/legal/privacy-policy": {
9999
"StatusCode": 200,
100-
"LastSeen": "2024-12-09T04:38:12.395804-05:00"
100+
"LastSeen": "2026-02-06T17:17:03.768131-05:00"
101101
},
102102
"https://www.netlify.com": {
103103
"StatusCode": 206,
104-
"LastSeen": "2024-12-09T04:37:50.350835-05:00"
104+
"LastSeen": "2026-02-06T17:17:03.156405-05:00"
105105
},
106106
"https://www.netlify.com/img/global/badges/netlify-color-accent.svg": {
107107
"StatusCode": 206,
108-
"LastSeen": "2024-12-09T04:37:55.463286-05:00"
108+
"LastSeen": "2026-02-06T17:17:03.318545-05:00"
109109
}
110110
}

0 commit comments

Comments
 (0)