diff --git a/CHANGELOG.md b/CHANGELOG.md index aeb0d45c..d1b8e62f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,13 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), ## [Unreleased] +## [2.0.1] - 2022-02-03 + +### Fixed + +- Hugo module error when downloading version 2 +- Emoji strings not displaying in table of contents + ## [2.0.0] - 2022-02-03 ### Added @@ -15,7 +22,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), - Site search powered by Fuse.js - Automatic Markdown image resizing and srcset generation - Performance and Accessibility improvements to achieve perfect Lighthouse scores -- Tables of Contents on article pages +- Tables of contents on article pages - Code copy buttons in article content - Taxonomy and term listings now support Markdown content - Taxonomies on article and list pages @@ -281,7 +288,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), - Advanced customisation using simple Tailwind colour definitions and styles - Fully documented -[unreleased]: https://github.com/jpanther/congo/compare/v2.0.0...HEAD +[unreleased]: https://github.com/jpanther/congo/compare/v2.0.1...HEAD +[2.0.1]: https://github.com/jpanther/congo/compare/v2.0.0...v2.0.1 [2.0.0]: https://github.com/jpanther/congo/compare/v1.6.4...v2.0.0 [1.6.4]: https://github.com/jpanther/congo/compare/v1.6.3...v1.6.4 [1.6.3]: https://github.com/jpanther/congo/compare/v1.6.2...v1.6.3 diff --git a/README.md b/README.md index 5f817a49..a9faccaa 100644 --- a/README.md +++ b/README.md @@ -62,7 +62,7 @@ Detailed instructions for each method can be found in the [Installation](https:/ ```toml [[imports]] - path = "github.com/jpanther/congo" + path = "github.com/jpanther/congo/v2" ``` 3. Start your server using `hugo server` and the theme will be downloaded automatically. diff --git a/assets/css/compiled/main.css b/assets/css/compiled/main.css index 43bd85a5..f8fccc66 100644 --- a/assets/css/compiled/main.css +++ b/assets/css/compiled/main.css @@ -1,4 +1,4 @@ -/*! Congo v2.0.0 | MIT License | https://github.com/jpanther/congo */ +/*! Congo v2.0.1 | MIT License | https://github.com/jpanther/congo */ /*! tailwindcss v3.0.18 | MIT License | https://tailwindcss.com */ diff --git a/assets/css/main.css b/assets/css/main.css index ea936c1d..9ff9cd85 100644 --- a/assets/css/main.css +++ b/assets/css/main.css @@ -1,4 +1,4 @@ -/*! Congo v2.0.0 | MIT License | https://github.com/jpanther/congo */ +/*! Congo v2.0.1 | MIT License | https://github.com/jpanther/congo */ @tailwind base; @tailwind components; diff --git a/exampleSite/content/docs/installation.md b/exampleSite/content/docs/installation.md index c35126b2..936c20ec 100644 --- a/exampleSite/content/docs/installation.md +++ b/exampleSite/content/docs/installation.md @@ -65,7 +65,7 @@ This method is the quickest and easiest for keeping the theme up-to-date. Hugo u ```toml [[imports]] - path = "github.com/jpanther/congo" + path = "github.com/jpanther/congo/v2" ``` 4. Start your server using `hugo server` and the theme will be downloaded automatically. diff --git a/exampleSite/content/docs/version-2/upgrade/index.md b/exampleSite/content/docs/version-2/upgrade/index.md index e9222b0e..350d0404 100644 --- a/exampleSite/content/docs/version-2/upgrade/index.md +++ b/exampleSite/content/docs/version-2/upgrade/index.md @@ -30,14 +30,14 @@ The process for upgrading Congo will depend on how you include the theme in your ### Upgrade using Hugo -Hugo makes updating modules super easy. Simply change into your project directory and execute the following command: +To upgrade a go module to a new major release, the `modules.toml` and `go.mod` files need to be updated. In each file, update the path to the theme from `github.com/jpanther/congo` to `github.com/jpanther/congo/v2`. + +Then change into your project directory and execute the following command: ```shell hugo mod get -u ``` -Hugo will automatically upgrade any modules that are required for your project. It does this by inspecting your `module.toml` and `go.mod` files. If you have any issues with the upgrade, check to ensure these files are still configured correctly. - Once the theme has been upgraded, continue to the [next section](#step-3-theme-configuration). ### Upgrade using git diff --git a/go.mod b/go.mod index c3b624da..b3f1e7f7 100644 --- a/go.mod +++ b/go.mod @@ -1,3 +1,3 @@ -module github.com/jpanther/congo +module github.com/jpanther/congo/v2 go 1.16 diff --git a/layouts/partials/toc.html b/layouts/partials/toc.html index 6be58579..bd32816e 100644 --- a/layouts/partials/toc.html +++ b/layouts/partials/toc.html @@ -7,6 +7,6 @@