Skip to content

Commit 2e9b76a

Browse files
urban-adeiningerdeining
authored andcommitted
Update to docsy theme version 0.7.1
1 parent 02a898c commit 2e9b76a

File tree

4 files changed

+30
-11
lines changed

4 files changed

+30
-11
lines changed

README.md

Lines changed: 25 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ In this project, the Docsy theme component is pulled in as a Hugo module, togeth
1111
$ hugo mod graph
1212
hugo: collected modules in 566 ms
1313
hugo: collected modules in 578 ms
14-
github.com/google/docsy-example github.com/google/[email protected].0
15-
github.com/google/docsy-example github.com/google/docsy/[email protected].0
16-
github.com/google/docsy/[email protected].0 github.com/twbs/[email protected]+incompatible
17-
github.com/google/docsy/[email protected].0 github.com/FortAwesome/[email protected]
14+
github.com/google/docsy-example github.com/google/[email protected].1
15+
github.com/google/docsy-example github.com/google/docsy/[email protected].1
16+
github.com/google/docsy/[email protected].1 github.com/twbs/[email protected]+incompatible
17+
github.com/google/docsy/[email protected].1 github.com/FortAwesome/[email protected]
1818
```
1919

2020
You can find detailed theme instructions in the [Docsy user guide][].
@@ -29,11 +29,13 @@ This is not an officially supported Google product. This project is currently ma
2929

3030
A simple way to get started is to use this project as a template, which gives you a site project that is set up and ready to use. To do this:
3131

32-
1. Click **Use this template**.
32+
1. Use the dropdown for switching branches/tags to change to the latest released tag `v0.7.1`
3333

34-
2. Select a name for your new project and click **Create repository from template**.
34+
2. Click **Use this template**.
3535

36-
3. Make your own local working copy of your new repo using git clone, replacing https://github.com/me/example.git with your repo’s web URL:
36+
3. Select a name for your new project and click **Create repository from template**.
37+
38+
4. Make your own local working copy of your new repo using git clone, replacing https://github.com/me/example.git with your repo’s web URL:
3739

3840
```bash
3941
git clone --depth 1 https://github.com/me/example.git
@@ -98,13 +100,26 @@ To remove the produced images run:
98100
```bash
99101
docker-compose rm
100102
```
101-
For more information see the [Docker Compose
102-
documentation](https://docs.docker.com/compose/gettingstarted/).
103+
For more information see the [Docker Compose documentation][].
103104

104105
## Troubleshooting
105106

106107
As you run the website locally, you may run into the following error:
107108

109+
```console
110+
$ hugo server
111+
WARN 2023/06/27 16:59:06 Module "project" is not compatible with this Hugo version; run "hugo mod graph" for more information.
112+
Start building sites …
113+
hugo v0.101.0-466fa43c16709b4483689930a4f9ac8add5c9f66+extended windows/amd64 BuildDate=2022-06-16T07:09:16Z VendorInfo=gohugoio
114+
Error: Error building site: "C:\Users\foo\path\to\docsy-example\content\en\_index.md:5:1": failed to extract shortcode: template for shortcode "blocks/cover" not found
115+
Built in 27 ms
116+
```
117+
118+
This error occurs if are running an outdated version of Hugo. As of docsy theme version `v0.7.0`, hugo version `0.110.0` or higher is required.
119+
See this [section](https://www.docsy.dev/docs/get-started/docsy-as-module/installation-prerequisites/#install-hugo) of the user guide for instructions on how to install Hugo.
120+
121+
Or you may be confronted with the following error:
122+
108123
```console
109124
$ hugo server
110125

@@ -136,3 +151,4 @@ See this [section](https://www.docsy.dev/docs/get-started/docsy-as-module/instal
136151
[example.docsy.dev]: https://example.docsy.dev
137152
[Hugo theme module]: https://gohugo.io/hugo-modules/use-modules/#use-a-module-for-a-theme
138153
[Netlify]: https://netlify.com
154+
[Docker Compose documentation]: https://docs.docker.com/compose/gettingstarted/

go.mod

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@ go 1.12
44

55
require (
66
github.com/FortAwesome/Font-Awesome v0.0.0-20230327165841-0698449d50f2 // indirect
7-
github.com/google/docsy v0.7.0 // indirect
7+
github.com/google/docsy v0.7.1 // indirect
88
github.com/twbs/bootstrap v5.2.3+incompatible // indirect
99
)

go.sum

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,12 @@ github.com/google/docsy v0.6.0 h1:43bVF18t2JihAamelQjjGzx1vO2ljCilVrBgetCA8oI=
1010
github.com/google/docsy v0.6.0/go.mod h1:VKKLqD8PQ7AglJc98yBorATfW7GrNVsn0kGXVYF6G+M=
1111
github.com/google/docsy v0.7.0 h1:JaeZ0/KufX/BJ3SyATb/fmZa1DFI7o5d9KU+i6+lLJY=
1212
github.com/google/docsy v0.7.0/go.mod h1:5WhIFchr5BfH6agjcInhpLRz7U7map0bcmKSpcrg6BE=
13+
github.com/google/docsy v0.7.1 h1:DUriA7Nr3lJjNi9Ulev1SfiG1sUYmvyDeU4nTp7uDxY=
14+
github.com/google/docsy v0.7.1/go.mod h1:JCmE+c+izhE0Rvzv3y+AzHhz1KdwlA9Oj5YBMklJcfc=
1315
github.com/google/docsy/dependencies v0.5.1/go.mod h1:EDGc2znMbGUw0RW5kWwy2oGgLt0iVXBmoq4UOqstuNE=
1416
github.com/google/docsy/dependencies v0.6.0/go.mod h1:EDGc2znMbGUw0RW5kWwy2oGgLt0iVXBmoq4UOqstuNE=
1517
github.com/google/docsy/dependencies v0.7.0/go.mod h1:gihhs5gmgeO+wuoay4FwOzob+jYJVyQbNaQOh788lD4=
18+
github.com/google/docsy/dependencies v0.7.1/go.mod h1:gihhs5gmgeO+wuoay4FwOzob+jYJVyQbNaQOh788lD4=
1619
github.com/twbs/bootstrap v4.6.2+incompatible h1:TDa+R51BTiy1wEHSYjmqDb8LxNl/zaEjAOpRE9Hwh/o=
1720
github.com/twbs/bootstrap v4.6.2+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0=
1821
github.com/twbs/bootstrap v5.2.3+incompatible h1:lOmsJx587qfF7/gE7Vv4FxEofegyJlEACeVV+Mt7cgc=

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "docsy-example-site",
3-
"version": "0.7.0-dev.0-unreleased",
3+
"version": "0.7.1",
44
"description": "Example site that uses Docsy theme for technical documentation.",
55
"repository": "github:google/docsy-example",
66
"homepage": "https://example.docsy.dev",

0 commit comments

Comments
 (0)