Skip to content

Commit 1c7f7e3

Browse files
authored
README.md: reflect changes due to use of theme as hugo module (#172)
1 parent 4db0471 commit 1c7f7e3

File tree

1 file changed

+27
-11
lines changed

1 file changed

+27
-11
lines changed

README.md

+27-11
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,20 @@
11
# Docsy Example
22

3-
[Docsy][] is a [Hugo theme][] for technical documentation sites, providing easy
4-
site navigation, structure, and more. This **Docsy Example Project** uses the
5-
Docsy theme and provides a skeleton documentation structure for you to use. You
6-
can clone/copy this project and edit it with your own content, or use it as an
7-
example.
3+
[Docsy][] is a [Hugo theme module][] for technical documentation sites, providing easy
4+
site navigation, structure, and more. This **Docsy Example Project** uses the Docsy
5+
theme component as a hugo module and provides a skeleton documentation structure for you to use.
6+
You can clone/copy this project and edit it with your own content, or use it as an example.
87

9-
In this project, the Docsy theme is included as a Git submodule:
8+
In this project, the Docsy theme component is pulled in as a Hugo module, together with other module dependencies:
109

1110
```bash
12-
$ git submodule
13-
...<hash>... themes/docsy (remotes/origin/HEAD)
11+
$ hugo mod graph
12+
hugo: collected modules in 566 ms
13+
hugo: collected modules in 578 ms
14+
github.com/google/docsy-example github.com/google/[email protected]
15+
github.com/google/docsy-example github.com/google/docsy/[email protected]
16+
github.com/google/docsy/[email protected] github.com/twbs/[email protected]+incompatible
17+
github.com/google/docsy/[email protected] github.com/FortAwesome/[email protected]
1418
```
1519

1620
You can find detailed theme instructions in the [Docsy user guide][].
@@ -32,7 +36,7 @@ A simple way to get started is to use this project as a template, which gives yo
3236
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:
3337

3438
```bash
35-
git clone --recurse-submodules --depth 1 https://github.com/me/example.git
39+
git clone --depth 1 https://github.com/me/example.git
3640
```
3741

3842
You can now edit your own versions of the site’s source files.
@@ -111,12 +115,24 @@ Error: Error building site: TOCSS: failed to transform "scss/main.scss" (text/x-
111115
```
112116

113117
This error occurs if you have not installed the extended version of Hugo.
114-
See our [user guide](https://www.docsy.dev/docs/getting-started/) for instructions on how to install Hugo.
118+
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.
119+
120+
Or you may encounter the following error:
121+
122+
```
123+
➜ hugo server
124+
125+
Error: failed to download modules: binary with name "go" not found
126+
```
127+
128+
This error occurs if you have not installed the `go` programming language on your system.
129+
See this [section](https://www.docsy.dev/docs/get-started/docsy-as-module/installation-prerequisites/#install-go-language) of the user guide for instructions on how to install `go`.
130+
115131

116132
[alternate dashboard]: https://app.netlify.com/sites/goldydocs/deploys
117133
[deploys]: https://app.netlify.com/sites/docsy-example/deploys
118134
[Docsy user guide]: https://docsy.dev/docs
119135
[Docsy]: https://github.com/google/docsy
120136
[example.docsy.dev]: https://example.docsy.dev
121-
[Hugo theme]: https://www.mikedane.com/static-site-generators/hugo/installing-using-themes/
137+
[Hugo theme module]: https://gohugo.io/hugo-modules/use-modules/#use-a-module-for-a-theme
122138
[Netlify]: https://netlify.com

0 commit comments

Comments
 (0)