From 2b4baf9797366d7bbfc136899496767e48c09fc1 Mon Sep 17 00:00:00 2001 From: Andreas Deininger Date: Tue, 27 May 2025 18:03:53 +0200 Subject: [PATCH] Upgrade Docsy to version 0.12.0 --- README.md | 4 ++-- content/en/docs/contribution-guidelines.md | 8 +++----- go.mod | 2 +- go.sum | 8 +++++--- hugo-disabled.toml | 2 +- hugo.yaml | 2 +- layouts/{_default => }/_markup/render-heading.html | 0 package.json | 4 ++-- 8 files changed, 15 insertions(+), 15 deletions(-) rename layouts/{_default => }/_markup/render-heading.html (100%) diff --git a/README.md b/README.md index ecf41558592..8b14d739dee 100644 --- a/README.md +++ b/README.md @@ -109,7 +109,7 @@ Clone the latest version of the docsy theme into the parent folder of your proje ```shell cd root-of-your-site -git clone --branch v0.7.2 https://github.com/google/docsy.git ../docsy +git clone --branch v0.12.0 https://github.com/google/docsy.git ../docsy ``` Now run: @@ -148,7 +148,7 @@ Error: Error building site: "C:\Users\foo\path\to\docsy-example\content\en\_inde Built in 27 ms ``` -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. +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. 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. Or you may be confronted with the following error: diff --git a/content/en/docs/contribution-guidelines.md b/content/en/docs/contribution-guidelines.md index c10be2c237d..51cdb9d3b23 100644 --- a/content/en/docs/contribution-guidelines.md +++ b/content/en/docs/contribution-guidelines.md @@ -57,11 +57,11 @@ If you've just spotted something you'd like to change while using the docs, Docs If you want to run your own local Hugo server to preview your changes as you work: -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. -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. +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. +1. Fork the [Goldydocs repo](https://github.com/google/docsy-example) repo into your own project, then create a local copy using `git clone`. ``` - git clone --recurse-submodules --depth 1 https://github.com/google/docsy-example.git + git clone --branch v0.12.0 --depth 1 https://github.com/google/docsy-example.git ``` 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 * [Docsy user guide](https://www.docsy.dev/docs/): All about Docsy, including how it manages navigation, look and feel, and multi-language support. * [Hugo documentation](https://gohugo.io/documentation/): Comprehensive reference for Hugo. * [Github Hello World!](https://guides.github.com/activities/hello-world/): A basic introduction to GitHub concepts and workflow. - - diff --git a/go.mod b/go.mod index f4c582a661c..08d01a3704c 100644 --- a/go.mod +++ b/go.mod @@ -2,4 +2,4 @@ module github.com/google/docsy-example go 1.12 -require github.com/google/docsy v0.11.1-0.20250424121410-343cdec14c0a +require github.com/google/docsy v0.12.0 diff --git a/go.sum b/go.sum index 70141939a09..8a42dcd1aa5 100644 --- a/go.sum +++ b/go.sum @@ -1,4 +1,6 @@ +github.com/FortAwesome/Font-Awesome v0.0.0-20241216213156-af620534bfc3 h1:/iluJkJiyTAdnqrw3Yi9rH2HNHhrrtCmj8VJe7I6o3w= github.com/FortAwesome/Font-Awesome v0.0.0-20241216213156-af620534bfc3/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo= -github.com/google/docsy v0.11.1-0.20250424121410-343cdec14c0a h1:yBtSn/NdYPZ2ScEyNbqCruLleEh+r6OS4kKCU2HYyEU= -github.com/google/docsy v0.11.1-0.20250424121410-343cdec14c0a/go.mod h1:jafNHER7YZwS1P24oXqemNBfGLXbGmcXX0HTQIip/N4= -github.com/twbs/bootstrap v5.3.5+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0= +github.com/google/docsy v0.12.0 h1:CddZKL39YyJzawr8GTVaakvcUTCJRAAYdz7W0qfZ2P4= +github.com/google/docsy v0.12.0/go.mod h1:1bioDqA493neyFesaTvQ9reV0V2vYy+xUAnlnz7+miM= +github.com/twbs/bootstrap v5.3.6+incompatible h1:efmXVyq839m5QQ0+JBUdQQ1TrmoBqvQ5kRhUueKsH+4= +github.com/twbs/bootstrap v5.3.6+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0= diff --git a/hugo-disabled.toml b/hugo-disabled.toml index 11101140678..78c81a64233 100644 --- a/hugo-disabled.toml +++ b/hugo-disabled.toml @@ -214,7 +214,7 @@ enable = false # workspace = "docsy.work" [module.hugoVersion] extended = true - min = "0.110.0" + min = "0.146.0" [[module.imports]] path = "github.com/google/docsy" disable = false diff --git a/hugo.yaml b/hugo.yaml index 90617120c82..eb7d2d07216 100644 --- a/hugo.yaml +++ b/hugo.yaml @@ -214,7 +214,7 @@ module: # workspace: docsy.work hugoVersion: extended: true - min: 0.110.0 + min: 0.146.0 imports: - path: github.com/google/docsy disable: false diff --git a/layouts/_default/_markup/render-heading.html b/layouts/_markup/render-heading.html similarity index 100% rename from layouts/_default/_markup/render-heading.html rename to layouts/_markup/render-heading.html diff --git a/package.json b/package.json index 2c17780686e..aab4986b0c1 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "docsy-example-site", - "version": "0.11.1-dev-unreleased", - "version.next": "0.12.0-dev-unreleased", + "version": "0.12.0", + "version.next": "0.12.1-dev-unreleased", "description": "Example site that uses Docsy theme for technical documentation.", "repository": "github:google/docsy-example", "homepage": "https://example.docsy.dev",