Skip to content

Commit 6fedbdb

Browse files
authored
Update to Docsy v0.14.0 and Hugo to 0.155.3 (#12)
1 parent 4aa0ca4 commit 6fedbdb

File tree

2 files changed

+15
-9
lines changed

2 files changed

+15
-9
lines changed

hugo.yaml

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# cSpell:ignore docsy github goldmark linkify netlify
1+
# cSpell:ignore docsy github goldmark linkify netlify hugo
22

33
baseURL: https://cncf-docsy-starter.netlify.app/ # CUSTOMIZE
44
title: Docsy Starter # CUSTOMIZE
@@ -81,11 +81,11 @@ params:
8181
sidebar_search_disable: false
8282
feedback: # CUSTOMIZE
8383
enable: false # FIXME: setting to false until the feedback can be better configured
84-
'yes': >-
84+
yes: >-
8585
Glad to hear it! Please <a
8686
href="https://github.com/google/docsy/issues/new">tell us how we can
8787
improve</a>.
88-
'no': >-
88+
no: >-
8989
Sorry to hear that. Please <a
9090
href="https://github.com/google/docsy/issues/new">tell us how we can
9191
improve</a>.
@@ -116,6 +116,8 @@ params:
116116
desc: GitHub repository for this starter
117117

118118
module:
119+
hugoVersion:
120+
min: 0.155.3
119121
mounts:
120122
- source: content/en
121123
target: content

package.json

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,12 @@
1010
"_diff:check": "git diff --name-only --exit-code",
1111
"_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",
1212
"_filenames-to-kebab-case": "find assets content -name '*_*' ! -name '[_.]*' -exec sh -c 'mv \"$1\" \"${1//_/-}\"' _ {} \\;",
13-
"_hugo-dev": "npm run _hugo -- -e dev -DFE",
13+
"_hugo-dev": "npm run _hugo-npm-setup && npm run _hugo -- -e dev -DFE",
14+
"_hugo-npm-setup": "npm --prefix node_modules/docsy run postinstall",
1415
"_hugo": "hugo --cleanDestinationDir",
1516
"_ls-bad-filenames": "find assets content -name '*_*' ! -name '[_.]*'",
1617
"_serve": "npm run _hugo-dev -- serve --minify --disableFastRender --renderToMemory",
18+
"_preupdate:docsy": "echo 'INFO: forcing a full clean install of Docsy'; rm -f package-lock.json",
1719
"build:preview": "npm run _hugo-dev -- --minify --baseURL \"${DEPLOY_PRIME_URL:-http://localhost}\"",
1820
"build:production": "npm run _hugo -- --minify",
1921
"build": "npm run _build --",
@@ -29,22 +31,24 @@
2931
"make:public": "git init public",
3032
"postbuild:preview": "npm run _check:links--warn",
3133
"postbuild:production": "npm run _check:links--warn",
32-
"postinstall": "npm --prefix node_modules/docsy run postinstall",
34+
"postinstall": "npm run _hugo-npm-setup",
3335
"precheck:links:all": "npm run build",
3436
"precheck:links": "npm run build",
37+
"preupdate:docsy": "npm run _preupdate:docsy && echo 'INFO: set DOCSY_VERSION to desired Docsy version'",
3538
"random:text": "node scripts/random-text.js",
3639
"seq": "bash -c 'for cmd in \"$@\"; do npm run $cmd || exit 1; done' - ",
3740
"serve": "npm run _serve",
3841
"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",
42+
"update:docsy:local": "npm run preupdate:docsy && npm install -D file:../docsy/docsy && npm list docsy",
43+
"update:docsy:main": "npm run preupdate:docsy && npm install -D google/docsy#main && npm list docsy",
44+
"update:docsy": "DOCSY_VERSION=${DOCSY_VERSION:-0.14.0} npm install -D google/docsy#semver:$DOCSY_VERSION && npm list docsy",
4145
"update:hugo": "npm install --save-exact -D hugo-extended@latest",
4246
"update:packages": "npx npm-check-updates --dep 'prod,dev,optional,peer' -u"
4347
},
4448
"devDependencies": {
4549
"autoprefixer": "^10.4.21",
4650
"cspell": "^9.0.2",
47-
"docsy": "github:google/docsy#main",
51+
"docsy": "github:google/docsy#semver:",
4852
"hugo-extended": "0.155.3",
4953
"postcss-cli": "^11.0.1",
5054
"prettier": "^3.5.3"
@@ -63,5 +67,5 @@
6367
"proseWrap": "always",
6468
"singleQuote": true
6569
},
66-
"spelling": "cSpell:ignore docsy hugo HTMLTEST netlify precheck postbuild -"
70+
"spelling": "cSpell:ignore docsy hugo HTMLTEST netlify precheck postbuild preupdate -"
6771
}

0 commit comments

Comments
 (0)