From 2e9b76a18d771f13b76e00abbad21a37b31cc857 Mon Sep 17 00:00:00 2001 From: Andreas Deininger Date: Tue, 27 Jun 2023 17:13:40 +0200 Subject: [PATCH] Update to docsy theme version 0.7.1 --- README.md | 34 +++++++++++++++++++++++++--------- go.mod | 2 +- go.sum | 3 +++ package.json | 2 +- 4 files changed, 30 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index c000dbb472..7f5ca59818 100644 --- a/README.md +++ b/README.md @@ -11,10 +11,10 @@ In this project, the Docsy theme component is pulled in as a Hugo module, togeth $ hugo mod graph hugo: collected modules in 566 ms hugo: collected modules in 578 ms -github.com/google/docsy-example github.com/google/docsy@v0.7.0 -github.com/google/docsy-example github.com/google/docsy/dependencies@v0.7.0 -github.com/google/docsy/dependencies@v0.7.0 github.com/twbs/bootstrap@v5.2.3+incompatible -github.com/google/docsy/dependencies@v0.7.0 github.com/FortAwesome/Font-Awesome@v0.0.0-20230327165841-0698449d50f2 +github.com/google/docsy-example github.com/google/docsy@v0.7.1 +github.com/google/docsy-example github.com/google/docsy/dependencies@v0.7.1 +github.com/google/docsy/dependencies@v0.7.1 github.com/twbs/bootstrap@v5.2.3+incompatible +github.com/google/docsy/dependencies@v0.7.1 github.com/FortAwesome/Font-Awesome@v0.0.0-20230327165841-0698449d50f2 ``` 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 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: -1. Click **Use this template**. +1. Use the dropdown for switching branches/tags to change to the latest released tag `v0.7.1` -2. Select a name for your new project and click **Create repository from template**. +2. Click **Use this template**. -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: +3. Select a name for your new project and click **Create repository from template**. + +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: ```bash git clone --depth 1 https://github.com/me/example.git @@ -98,13 +100,26 @@ To remove the produced images run: ```bash docker-compose rm ``` -For more information see the [Docker Compose -documentation](https://docs.docker.com/compose/gettingstarted/). +For more information see the [Docker Compose documentation][]. ## Troubleshooting As you run the website locally, you may run into the following error: +```console +$ hugo server +WARN 2023/06/27 16:59:06 Module "project" is not compatible with this Hugo version; run "hugo mod graph" for more information. +Start building sites … +hugo v0.101.0-466fa43c16709b4483689930a4f9ac8add5c9f66+extended windows/amd64 BuildDate=2022-06-16T07:09:16Z VendorInfo=gohugoio +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 +Built in 27 ms +``` + +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. +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: + ```console $ hugo server @@ -136,3 +151,4 @@ See this [section](https://www.docsy.dev/docs/get-started/docsy-as-module/instal [example.docsy.dev]: https://example.docsy.dev [Hugo theme module]: https://gohugo.io/hugo-modules/use-modules/#use-a-module-for-a-theme [Netlify]: https://netlify.com +[Docker Compose documentation]: https://docs.docker.com/compose/gettingstarted/ diff --git a/go.mod b/go.mod index 56f6887ab0..ec0974f561 100644 --- a/go.mod +++ b/go.mod @@ -4,6 +4,6 @@ go 1.12 require ( github.com/FortAwesome/Font-Awesome v0.0.0-20230327165841-0698449d50f2 // indirect - github.com/google/docsy v0.7.0 // indirect + github.com/google/docsy v0.7.1 // indirect github.com/twbs/bootstrap v5.2.3+incompatible // indirect ) diff --git a/go.sum b/go.sum index bf4a2c8228..e1d4ad4df7 100644 --- a/go.sum +++ b/go.sum @@ -10,9 +10,12 @@ github.com/google/docsy v0.6.0 h1:43bVF18t2JihAamelQjjGzx1vO2ljCilVrBgetCA8oI= github.com/google/docsy v0.6.0/go.mod h1:VKKLqD8PQ7AglJc98yBorATfW7GrNVsn0kGXVYF6G+M= github.com/google/docsy v0.7.0 h1:JaeZ0/KufX/BJ3SyATb/fmZa1DFI7o5d9KU+i6+lLJY= github.com/google/docsy v0.7.0/go.mod h1:5WhIFchr5BfH6agjcInhpLRz7U7map0bcmKSpcrg6BE= +github.com/google/docsy v0.7.1 h1:DUriA7Nr3lJjNi9Ulev1SfiG1sUYmvyDeU4nTp7uDxY= +github.com/google/docsy v0.7.1/go.mod h1:JCmE+c+izhE0Rvzv3y+AzHhz1KdwlA9Oj5YBMklJcfc= github.com/google/docsy/dependencies v0.5.1/go.mod h1:EDGc2znMbGUw0RW5kWwy2oGgLt0iVXBmoq4UOqstuNE= github.com/google/docsy/dependencies v0.6.0/go.mod h1:EDGc2znMbGUw0RW5kWwy2oGgLt0iVXBmoq4UOqstuNE= github.com/google/docsy/dependencies v0.7.0/go.mod h1:gihhs5gmgeO+wuoay4FwOzob+jYJVyQbNaQOh788lD4= +github.com/google/docsy/dependencies v0.7.1/go.mod h1:gihhs5gmgeO+wuoay4FwOzob+jYJVyQbNaQOh788lD4= github.com/twbs/bootstrap v4.6.2+incompatible h1:TDa+R51BTiy1wEHSYjmqDb8LxNl/zaEjAOpRE9Hwh/o= github.com/twbs/bootstrap v4.6.2+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0= github.com/twbs/bootstrap v5.2.3+incompatible h1:lOmsJx587qfF7/gE7Vv4FxEofegyJlEACeVV+Mt7cgc= diff --git a/package.json b/package.json index 2bacfd3d59..569ce41d61 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "docsy-example-site", - "version": "0.7.0-dev.0-unreleased", + "version": "0.7.1", "description": "Example site that uses Docsy theme for technical documentation.", "repository": "github:google/docsy-example", "homepage": "https://example.docsy.dev",