Skip to content

Commit e6f6fdb

Browse files
authored
Upgrade Docsy to version 0.12.0 (#368)
1 parent 77063d2 commit e6f6fdb

File tree

8 files changed

+15
-15
lines changed

8 files changed

+15
-15
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ Clone the latest version of the docsy theme into the parent folder of your proje
109109

110110
```shell
111111
cd root-of-your-site
112-
git clone --branch v0.7.2 https://github.com/google/docsy.git ../docsy
112+
git clone --branch v0.12.0 https://github.com/google/docsy.git ../docsy
113113
```
114114

115115
Now run:
@@ -148,7 +148,7 @@ Error: Error building site: "C:\Users\foo\path\to\docsy-example\content\en\_inde
148148
Built in 27 ms
149149
```
150150

151-
This error occurs if you are running an outdated version of Hugo. As of docsy theme version `v0.7.0`, hugo version `0.110.0` or higher is required.
151+
This error occurs if you are running an outdated version of Hugo. As of docsy theme version `v0.12.0`, hugo version `0.146.0` or higher is required.
152152
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.
153153

154154
Or you may be confronted with the following error:

content/en/docs/contribution-guidelines.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -57,11 +57,11 @@ If you've just spotted something you'd like to change while using the docs, Docs
5757

5858
If you want to run your own local Hugo server to preview your changes as you work:
5959

60-
1. Follow the instructions in [Getting started](/docs/getting-started) to install Hugo and any other tools you need. You'll need at least **Hugo version 0.45** (we recommend using the most recent available version), and it must be the **extended** version, which supports SCSS.
61-
1. Fork the [Goldydocs repo](https://github.com/google/docsy-example) repo into your own project, then create a local copy using `git clone`. Don’t forget to use `--recurse-submodules` or you won’t pull down some of the code you need to generate a working site.
60+
1. Follow the instructions in [Getting started](/docs/getting-started) to install Hugo and any other tools you need. You'll need at least **Hugo version 0.146.0** (we recommend using the most recent available version), and it must be the **extended** version, which supports SCSS.
61+
1. Fork the [Goldydocs repo](https://github.com/google/docsy-example) repo into your own project, then create a local copy using `git clone`.
6262

6363
```
64-
git clone --recurse-submodules --depth 1 https://github.com/google/docsy-example.git
64+
git clone --branch v0.12.0 --depth 1 https://github.com/google/docsy-example.git
6565
```
6666

6767
1. Run `hugo server` in the site root directory. By default your site will be available at http://localhost:1313/. Now that you're serving your site locally, Hugo will watch for changes to the content and automatically refresh your site.
@@ -77,5 +77,3 @@ If you've found a problem in the docs, but you're not sure how to fix it yoursel
7777
* [Docsy user guide](https://www.docsy.dev/docs/): All about Docsy, including how it manages navigation, look and feel, and multi-language support.
7878
* [Hugo documentation](https://gohugo.io/documentation/): Comprehensive reference for Hugo.
7979
* [Github Hello World!](https://guides.github.com/activities/hello-world/): A basic introduction to GitHub concepts and workflow.
80-
81-

go.mod

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@ module github.com/google/docsy-example
22

33
go 1.12
44

5-
require github.com/google/docsy v0.11.1-0.20250424121410-343cdec14c0a
5+
require github.com/google/docsy v0.12.0

go.sum

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1+
github.com/FortAwesome/Font-Awesome v0.0.0-20241216213156-af620534bfc3 h1:/iluJkJiyTAdnqrw3Yi9rH2HNHhrrtCmj8VJe7I6o3w=
12
github.com/FortAwesome/Font-Awesome v0.0.0-20241216213156-af620534bfc3/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo=
2-
github.com/google/docsy v0.11.1-0.20250424121410-343cdec14c0a h1:yBtSn/NdYPZ2ScEyNbqCruLleEh+r6OS4kKCU2HYyEU=
3-
github.com/google/docsy v0.11.1-0.20250424121410-343cdec14c0a/go.mod h1:jafNHER7YZwS1P24oXqemNBfGLXbGmcXX0HTQIip/N4=
4-
github.com/twbs/bootstrap v5.3.5+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0=
3+
github.com/google/docsy v0.12.0 h1:CddZKL39YyJzawr8GTVaakvcUTCJRAAYdz7W0qfZ2P4=
4+
github.com/google/docsy v0.12.0/go.mod h1:1bioDqA493neyFesaTvQ9reV0V2vYy+xUAnlnz7+miM=
5+
github.com/twbs/bootstrap v5.3.6+incompatible h1:efmXVyq839m5QQ0+JBUdQQ1TrmoBqvQ5kRhUueKsH+4=
6+
github.com/twbs/bootstrap v5.3.6+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0=

hugo-disabled.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,7 @@ enable = false
214214
# workspace = "docsy.work"
215215
[module.hugoVersion]
216216
extended = true
217-
min = "0.110.0"
217+
min = "0.146.0"
218218
[[module.imports]]
219219
path = "github.com/google/docsy"
220220
disable = false

hugo.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,7 @@ module:
214214
# workspace: docsy.work
215215
hugoVersion:
216216
extended: true
217-
min: 0.110.0
217+
min: 0.146.0
218218
imports:
219219
- path: github.com/google/docsy
220220
disable: false
File renamed without changes.

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "docsy-example-site",
3-
"version": "0.11.1-dev-unreleased",
4-
"version.next": "0.12.0-dev-unreleased",
3+
"version": "0.12.0",
4+
"version.next": "0.12.1-dev-unreleased",
55
"description": "Example site that uses Docsy theme for technical documentation.",
66
"repository": "github:google/docsy-example",
77
"homepage": "https://example.docsy.dev",

0 commit comments

Comments
 (0)