Skip to content

Commit

Permalink
🔖 Release v2.0.1
Browse files Browse the repository at this point in the history
  • Loading branch information
jpanther committed Feb 3, 2022
2 parents 2b330b2 + e24c26d commit b13dea3
Show file tree
Hide file tree
Showing 10 changed files with 44 additions and 36 deletions.
12 changes: 10 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion assets/css/compiled/main.css
Original file line number Diff line number Diff line change
@@ -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 */

Expand Down
2 changes: 1 addition & 1 deletion assets/css/main.css
Original file line number Diff line number Diff line change
@@ -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;
Expand Down
2 changes: 1 addition & 1 deletion exampleSite/content/docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
6 changes: 3 additions & 3 deletions exampleSite/content/docs/version-2/upgrade/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion go.mod
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
module github.com/jpanther/congo
module github.com/jpanther/congo/v2

go 1.16
2 changes: 1 addition & 1 deletion layouts/partials/toc.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@
<div
class="py-2 border-dotted ltr:border-l rtl:border-r rtl:pr-5 ltr:pl-5 ltr:-ml-5 rtl:-mr-5 border-neutral-300 dark:border-neutral-600"
>
{{ .TableOfContents }}
{{ .TableOfContents | emojify }}
</div>
</details>
48 changes: 24 additions & 24 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "hugo-congo-theme",
"version": "2.0.0",
"version": "2.0.1",
"description": "Congo theme for Hugo",
"main": "index.js",
"scripts": {
Expand Down

0 comments on commit b13dea3

Please sign in to comment.