Skip to content

Commit 4aa0ca4

Browse files
authored
Update to Docsy v0.13.0-102-g901887d3 via main, Hugo to 0.155.3 (#11)
1 parent 49e21d0 commit 4aa0ca4

File tree

9 files changed

+80
-33
lines changed

9 files changed

+80
-33
lines changed

assets/scss/_styles_project.scss

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
@import 'td/extra';
2+
@import 'td/extra/bs-defaults';
3+
14
@import 'td/color-adjustments-dark';
25
@import 'td/code-dark';
36
@import 'td/gcs-search-dark';

content/en/_index.md

Lines changed: 38 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,59 @@
11
---
22
title: Docsy starter
3-
description: A website starter for technical documentation
3+
description: A Docsy-themed website template for technical documentation
44
outputs:
55
- HTML
66
- REDIRECTS # Include this `content/en` ONLY
7-
developer_note:
8-
The blocks/cover shortcode (used below) will use as a background image any
9-
image file containing "background" in its name.
10-
show_banner: true
7+
params:
8+
body_class: td-navbar-links-all-active
9+
show_banner: true
1110
---
1211

13-
{{% blocks/cover title="Docsy Starter" image_anchor="top" height="full" %}}
12+
{{% blocks/cover
13+
title="Welcome to Docsy Starter!"
14+
height="full td-below-navbar"
15+
%}}
1416

1517
<!-- prettier-ignore -->
1618
{{% param description %}}
1719
{.display-6}
1820

19-
<a class="btn btn-lg btn-primary me-3" href="docs/">Learn More</a>
20-
<a class="btn btn-lg btn-secondary" href="docs/get-started/">Get started</a>
21-
{.p-initial .my-5}
22-
23-
{{% blocks/link-down color="info" %}} {{% /blocks/cover %}}
24-
25-
{{% blocks/lead color="primary" %}}
26-
27-
Docsy is a theme for the Hugo static site generator that's specifically designed
28-
for technical documentation sets. Our aim is to help you get a working
21+
<!-- prettier-ignore -->
22+
<div class="td-cta-buttons my-5">
23+
<a {{% _param btn-lg primary %}} href="docs/">
24+
Learn more
25+
</a>
26+
<a {{% _param btn-lg secondary %}}
27+
href="{{% param github_repo %}}"
28+
target="_blank" rel="noopener noreferrer">
29+
Get the template
30+
{{% _param FA brands github "" %}}
31+
</a>
32+
</div>
33+
34+
{{% blocks/link-down color="info" %}}
35+
36+
{{% /blocks/cover %}}
37+
38+
{{% blocks/lead color="white" %}}
39+
40+
Docsy is a theme for the [Hugo][] static site generator that's specifically
41+
designed for technical documentation sets. Our aim is to help you get a working
2942
documentation site up and running as easily as possible, so you can concentrate
3043
on creating great content for your users.
3144

32-
<a href="https://www.netlify.com" target="_blank" rel="noopener">
33-
<img src="https://www.netlify.com/img/global/badges/netlify-color-accent.svg" alt="Deploys by Netlify" />
34-
</a>
45+
[![Deploys by Netlify][netlify-badge]][netlify]
46+
47+
[Hugo]: https://gohugo.io/
48+
[netlify]: https://www.netlify.com/
49+
[netlify-badge]:
50+
https://www.netlify.com/img/global/badges/netlify-color-accent.svg
51+
3552
{{% /blocks/lead %}}
3653

37-
{{% blocks/section color="dark" type="row" %}}
54+
{{% blocks/section color="dark bg-gradient" type="row" %}}
3855

39-
{{% blocks/feature icon="fa-lightbulb" title="See Docsy in action!" url="/docs/examples/" %}}
56+
{{% blocks/feature icon="fa-lightbulb" title="See Docsy in action!" url="docs/examples/" %}}
4057

4158
As well as our example site, there's a growing number of projects using Docsy
4259
for their doc sites.
841 KB
Loading

content/en/blog/_index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,5 @@
22
title: Blog
33
menu: { main: { weight: 50 } }
44
---
5+
6+
{{% _param "pagePlaceholderNoteBody" %}}

content/en/docs/_index.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,4 @@ linkTitle: Docs
44
menu: { main: { weight: 20 } }
55
---
66

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.
7+
{{% _param "pagePlaceholderNoteBody" %}}

content/en/featured-background.jpg

-216 KB
Binary file not shown.

hugo.yaml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@ params:
6969
Project Authors | [CC BY 4.0](https://creativecommons.org/licenses/by/4.0)
7070
|
7171
from_year: 2024
72+
to_year: present
7273
github_repo: https://github.com/chalin/docsy-starter
7374
gcs_engine_id: b11e9c44d8d004464 # CUSTOMIZE - this is the starter ID
7475
privacy_policy: https://www.linuxfoundation.org/legal/privacy-policy
@@ -88,6 +89,16 @@ params:
8889
Sorry to hear that. Please <a
8990
href="https://github.com/google/docsy/issues/new">tell us how we can
9091
improve</a>.
92+
pagePlaceholderNoteBody: |
93+
**This is placeholder content**. Replace it with your own content. To learn
94+
more, see [Get started][] from the [Docsy][] User Guide.
95+
96+
[Docsy]: https://docsy.dev
97+
[Get started]: https://docsy.dev/docs/get-started/
98+
# Text macros: use with _param
99+
btn-lg: class="btn btn-lg btn-{1}" role="button"
100+
FA: <i class="fa-{1} fa-{2} text-{3} px-1"></i>
101+
91102
links: # CUSTOMIZE
92103
user:
93104
- name: User mailing list

package.json

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@
88
"_check:links": "make --keep-going check-links",
99
"_commit:public": "HASH=$(git rev-parse --short main); cd public && git add -A && git commit -m \"Site at $HASH\"",
1010
"_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",
1211
"_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",
1312
"_filenames-to-kebab-case": "find assets content -name '*_*' ! -name '[_.]*' -exec sh -c 'mv \"$1\" \"${1//_/-}\"' _ {} \\;",
1413
"_hugo-dev": "npm run _hugo -- -e dev -DFE",
@@ -30,19 +29,23 @@
3029
"make:public": "git init public",
3130
"postbuild:preview": "npm run _check:links--warn",
3231
"postbuild:production": "npm run _check:links--warn",
33-
"postinstall": "test ! -d node_modules/docsy || npm run _ensure:docsy-hugo-modules",
32+
"postinstall": "npm --prefix node_modules/docsy run postinstall",
3433
"precheck:links:all": "npm run build",
3534
"precheck:links": "npm run build",
35+
"random:text": "node scripts/random-text.js",
3636
"seq": "bash -c 'for cmd in \"$@\"; do npm run $cmd || exit 1; done' - ",
3737
"serve": "npm run _serve",
38-
"test": "npm run check:format && npm run check:links",
38+
"test": "npm list docsy && npm run check:format && npm run check:links",
39+
"update:docsy:local": "npm install -D file:../docsy/docsy && npm list docsy",
40+
"update:docsy:main": "npm install -D google/docsy#main && npm list docsy",
41+
"update:hugo": "npm install --save-exact -D hugo-extended@latest",
3942
"update:packages": "npx npm-check-updates --dep 'prod,dev,optional,peer' -u"
4043
},
4144
"devDependencies": {
4245
"autoprefixer": "^10.4.21",
4346
"cspell": "^9.0.2",
44-
"docsy": "google/docsy#semver:0.13.0",
45-
"hugo-extended": "^0.152.2",
47+
"docsy": "github:google/docsy#main",
48+
"hugo-extended": "0.155.3",
4649
"postcss-cli": "^11.0.1",
4750
"prettier": "^3.5.3"
4851
},
@@ -54,7 +57,7 @@
5457
"engines": {
5558
"node": ">=24"
5659
},
57-
"gitHubActionCacheKey": "2026-02-06 - refresh cache for Docsy 0.13.0 and Hugo 0.152.2",
60+
"gitHubActionCacheKey": "2026-02-09 - refresh cache for Docsy and latest hugo-extended",
5861
"private": true,
5962
"prettier": {
6063
"proseWrap": "always",

static/refcache.json

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,14 @@
77
"StatusCode": 206,
88
"LastSeen": "2026-02-06T17:17:03.380923-05:00"
99
},
10+
"https://docsy.dev": {
11+
"StatusCode": 206,
12+
"LastSeen": "2026-02-09T14:45:58.320155-05:00"
13+
},
14+
"https://docsy.dev/docs/get-started/": {
15+
"StatusCode": 206,
16+
"LastSeen": "2026-02-09T14:45:58.167499-05:00"
17+
},
1018
"https://git-scm.com/book/en/v2/Git-Tools-Submodules": {
1119
"StatusCode": 206,
1220
"LastSeen": "2026-02-06T17:17:04.955354-05:00"
@@ -75,6 +83,10 @@
7583
"StatusCode": 206,
7684
"LastSeen": "2026-02-06T17:17:04.060212-05:00"
7785
},
86+
"https://gohugo.io/": {
87+
"StatusCode": 206,
88+
"LastSeen": "2026-02-09T05:09:16.548751-05:00"
89+
},
7890
"https://gohugo.io/hugo-modules/": {
7991
"StatusCode": 206,
8092
"LastSeen": "2026-02-06T17:17:04.172438-05:00"
@@ -103,6 +115,10 @@
103115
"StatusCode": 206,
104116
"LastSeen": "2026-02-06T17:17:03.156405-05:00"
105117
},
118+
"https://www.netlify.com/": {
119+
"StatusCode": 206,
120+
"LastSeen": "2026-02-09T05:09:16.606996-05:00"
121+
},
106122
"https://www.netlify.com/img/global/badges/netlify-color-accent.svg": {
107123
"StatusCode": 206,
108124
"LastSeen": "2026-02-06T17:17:03.318545-05:00"

0 commit comments

Comments
 (0)