Skip to content

Commit

Permalink
User guide: module definition: add 'proxy' attribute
Browse files Browse the repository at this point in the history
  • Loading branch information
deining committed May 13, 2022
1 parent 060d0ed commit 8741151
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 2 deletions.
2 changes: 1 addition & 1 deletion netlify.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ publish = "userguide/public"
command = "npm run docs-install && npm run build:preview"

[build.environment]
GO_VERSION = "1.18"
GO_VERSION = "1.18.2"
HUGO_THEME = "repo"

[context.production]
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,6 @@
"bootstrap": "^4.6.1"
},
"devDependencies": {
"hugo-extended": "0.96.0"
"hugo-extended": "0.98.0"
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ hugo mod init github.com/me/my-new-site
hugo mod get github.com/google/docsy@v0.2.0
cat >> config.toml <<EOL
[module]
proxy = "direct"
[[module.imports]]
path = "github.com/google/docsy"
[[module.imports]]
Expand All @@ -37,6 +38,8 @@ hugo mod init github.com/me/my-new-site
hugo mod get github.com/google/docsy@v0.2.0
(echo [module]^

proxy = "direct"^

[[module.imports]]^

path = "github.com/google/docsy"^
Expand Down Expand Up @@ -91,6 +94,7 @@ Add the settings in the following snippet at the end of your site configuration
{{< tabpane >}}
{{< tab header="config.toml" >}}
[module]
proxy = "direct"
# uncomment line below for temporary local development of module
# replacements = "github.com/google/docsy -> ../../docsy"
[module.hugoVersion]
Expand All @@ -105,6 +109,7 @@ Add the settings in the following snippet at the end of your site configuration
{{< /tab >}}
{{< tab header="config.yaml" >}}
module:
proxy: direct
hugoVersion:
extended: true
min: 0.73.0
Expand All @@ -118,6 +123,7 @@ module:
{{< tab header="config.json" >}}
{
"module": {
"proxy": "direct",
"hugoVersion": {
"extended": true,
"min": "0.73.0"
Expand Down
6 changes: 6 additions & 0 deletions userguide/content/en/docs/Updating/Convert-site-to-module.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ hugo mod get github.com/google/docsy@v0.2.0
sed -i '/theme = \["docsy"\]/d' config.toml
cat >> config.toml <<EOL
[module]
proxy = "direct"
[[module.imports]]
path = "github.com/google/docsy"
[[module.imports]]
Expand All @@ -33,6 +34,8 @@ findstr /v /c:"theme = [\"docsy\"]" config.toml > config.toml.temp
move /Y config.toml.temp config.toml
(echo [module]^

proxy = "direct"^

[[module.imports]]^

path = "github.com/google/docsy"^
Expand Down Expand Up @@ -90,6 +93,7 @@ Alternatively, you can omit this line altogether and replace it with the setting
{{< tabpane >}}
{{< tab header="config.toml" >}}
[module]
proxy = "direct"
# uncomment line below for temporary local development of module
# replacements = "github.com/google/docsy -> ../../docsy"
[module.hugoVersion]
Expand All @@ -104,6 +108,7 @@ Alternatively, you can omit this line altogether and replace it with the setting
{{< /tab >}}
{{< tab header="config.yaml" >}}
module:
proxy: direct
hugoVersion:
extended: true
min: 0.73.0
Expand All @@ -117,6 +122,7 @@ module:
{{< tab header="config.json" >}}
{
"module": {
"proxy": "direct",
"hugoVersion": {
"extended": true,
"min": "0.73.0"
Expand Down

0 comments on commit 8741151

Please sign in to comment.