Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/google/docsy.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPatrice Chalin <pchalin@gmail.com>2022-07-15 20:48:54 +0300
committerGeri Ochoa <gerino@protonmail.com>2022-08-02 17:59:03 +0300
commit26d3e99a2c4d41cc2b69e35211306f694f5c069e (patch)
tree78fb2b896f96d13e4840002dfcf87d46bac7b2ea
parent33b2028be964441a5efa801de482ba9a08ec8119 (diff)
Set docsy version in config as `version`
-rw-r--r--userguide/config.toml2
-rw-r--r--userguide/content/en/docs/Updating/Convert-site-to-module.md14
-rw-r--r--userguide/content/en/docs/Updating/Updating-hugo-module.md4
-rw-r--r--userguide/content/en/docs/get-started/docsy-as-module/start-from-scratch.md6
4 files changed, 13 insertions, 13 deletions
diff --git a/userguide/config.toml b/userguide/config.toml
index 3836183..2bfe49c 100644
--- a/userguide/config.toml
+++ b/userguide/config.toml
@@ -85,7 +85,7 @@ archived_version = false
# The version number for the version of the docs represented in this doc set.
# Used in the "version-banner" partial to display a version number for the
# current doc set.
-version = "0.0"
+version = "0.4.0"
# A link to latest version of the docs. Used in the "version-banner" partial to
# point people to the main doc site.
diff --git a/userguide/content/en/docs/Updating/Convert-site-to-module.md b/userguide/content/en/docs/Updating/Convert-site-to-module.md
index 53b9cee..bf2c1ff 100644
--- a/userguide/content/en/docs/Updating/Convert-site-to-module.md
+++ b/userguide/content/en/docs/Updating/Convert-site-to-module.md
@@ -15,7 +15,7 @@ Run the following from the command line:
{{< tab header="Unix shell" lang="Bash" >}}
cd /path/to/my-existing-site
hugo mod init github.com/me-at-github/my-existing-site
-hugo mod get github.com/google/docsy@v0.4.0
+hugo mod get github.com/google/docsy@v{{% param "version" %}}
sed -i '/theme = \["docsy"\]/d' config.toml
cat >> config.toml <<EOL
[module]
@@ -30,7 +30,7 @@ hugo server
{{< tab header="Windows command line" lang="Batchfile" >}}
cd my-existing-site
hugo mod init github.com/me-at-github/my-existing-site
-hugo mod get github.com/google/docsy@v0.4.0
+hugo mod get github.com/google/docsy@v{{% param "version" %}}
findstr /v /c:"theme = [\"docsy\"]" config.toml > config.toml.temp
move /Y config.toml.temp config.toml
(echo [module]^
@@ -70,7 +70,7 @@ This creates two new files, `go.mod` for the module definitions and `go.sum` whi
Next declare the Docsy theme module as a dependency for your site.
```bash
-hugo mod get github.com/google/docsy@v0.4.0
+hugo mod get github.com/google/docsy@v{{% param "version" %}}
```
This command adds the `docsy` theme module to your definition file `go.mod`.
@@ -181,10 +181,10 @@ To make sure that your configuration settings are correct, run the command `hugo
```bash
hugo mod graph
hugo: collected modules in 1092 ms
-github.com/me/my-existing-site github.com/google/docsy@v0.4.0
-github.com/me/my-existing-site github.com/google/docsy/dependencies@v0.4.0
-github.com/google/docsy/dependencies@v0.4.0 github.com/twbs/bootstrap@v4.6.1+incompatible
-github.com/google/docsy/dependencies@v0.4.0 github.com/FortAwesome/Font-Awesome@v0.0.0-20210804190922-7d3d774145ac
+github.com/me/my-existing-site github.com/google/docsy@v{{% param "version" %}}
+github.com/me/my-existing-site github.com/google/docsy/dependencies@v{{% param "version" %}}
+github.com/google/docsy/dependencies@v{{% param "version" %}} github.com/twbs/bootstrap@v4.6.1+incompatible
+github.com/google/docsy/dependencies@v{{% param "version" %}} github.com/FortAwesome/Font-Awesome@v0.0.0-20210804190922-7d3d774145ac
```
Make sure that three lines with dependencies `docsy`, `bootstrap` and `Font-Awesome` are listed. If not, please double check your config settings.
diff --git a/userguide/content/en/docs/Updating/Updating-hugo-module.md b/userguide/content/en/docs/Updating/Updating-hugo-module.md
index bbe864a..5065046 100644
--- a/userguide/content/en/docs/Updating/Updating-hugo-module.md
+++ b/userguide/content/en/docs/Updating/Updating-hugo-module.md
@@ -24,10 +24,10 @@ Hugo automatically pulls in the latest theme version. That's it, your update is
{{% alert title="Tip" %}}
-If you want to set your module to a certain version inside the docsy theme repo, simply specific the name of the tag representing this version (here: _v0.4.0_) when updating your theme:
+If you want to set your module to a certain version inside the docsy theme repo, simply specific the name of the tag representing this version (here: _v{{% param "version" %}}_) when updating your theme:
```bash
-hugo mod get -u github.com/google/docsy@v0.4.0
+hugo mod get -u github.com/google/docsy@v{{% param "version" %}}
```
Instead of a version tag, you can also specify a commit hash inside the repo (here: _6c8a3afe_) when updating your theme:
diff --git a/userguide/content/en/docs/get-started/docsy-as-module/start-from-scratch.md b/userguide/content/en/docs/get-started/docsy-as-module/start-from-scratch.md
index c89985f..2a29ee2 100644
--- a/userguide/content/en/docs/get-started/docsy-as-module/start-from-scratch.md
+++ b/userguide/content/en/docs/get-started/docsy-as-module/start-from-scratch.md
@@ -21,7 +21,7 @@ At your command prompt, run the following:
hugo new site my-new-site
cd my-new-site
hugo mod init github.com/me/my-new-site
-hugo mod get github.com/google/docsy@v0.4.0
+hugo mod get github.com/google/docsy@v{{% param "version" %}}
cat >> config.toml <<EOL
[module]
proxy = "direct"
@@ -36,7 +36,7 @@ hugo server
hugo new site my-new-site
cd my-new-site
hugo mod init github.com/me/my-new-site
-hugo mod get github.com/google/docsy@v0.4.0
+hugo mod get github.com/google/docsy@v{{% param "version" %}}
(echo [module]^
proxy = "direct"^
@@ -83,7 +83,7 @@ This creates two new files, `go.mod` for the module definitions and `go.sum` whi
Next declare the Docsy theme module as a dependency for your site.
```bash
-hugo mod get github.com/google/docsy@v0.4.0
+hugo mod get github.com/google/docsy@v{{% param "version" %}}
```
This command adds the `docsy` theme module to your definition file `go.mod`.