mirror of https://github.com/jpanther/congo.git
commit
b13dea3b68
12
CHANGELOG.md
12
CHANGELOG.md
|
@ -6,6 +6,13 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
||||||
|
|
||||||
## [Unreleased]
|
## [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
|
## [2.0.0] - 2022-02-03
|
||||||
|
|
||||||
### Added
|
### 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
|
- Site search powered by Fuse.js
|
||||||
- Automatic Markdown image resizing and srcset generation
|
- Automatic Markdown image resizing and srcset generation
|
||||||
- Performance and Accessibility improvements to achieve perfect Lighthouse scores
|
- 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
|
- Code copy buttons in article content
|
||||||
- Taxonomy and term listings now support Markdown content
|
- Taxonomy and term listings now support Markdown content
|
||||||
- Taxonomies on article and list pages
|
- 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
|
- Advanced customisation using simple Tailwind colour definitions and styles
|
||||||
- Fully documented
|
- 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
|
[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.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
|
[1.6.3]: https://github.com/jpanther/congo/compare/v1.6.2...v1.6.3
|
||||||
|
|
|
@ -62,7 +62,7 @@ Detailed instructions for each method can be found in the [Installation](https:/
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
[[imports]]
|
[[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.
|
3. Start your server using `hugo server` and the theme will be downloaded automatically.
|
||||||
|
|
|
@ -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 */
|
/*! tailwindcss v3.0.18 | MIT License | https://tailwindcss.com */
|
||||||
|
|
||||||
|
|
|
@ -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 base;
|
||||||
@tailwind components;
|
@tailwind components;
|
||||||
|
|
|
@ -65,7 +65,7 @@ This method is the quickest and easiest for keeping the theme up-to-date. Hugo u
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
[[imports]]
|
[[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.
|
4. Start your server using `hugo server` and the theme will be downloaded automatically.
|
||||||
|
|
|
@ -30,14 +30,14 @@ The process for upgrading Congo will depend on how you include the theme in your
|
||||||
|
|
||||||
### Upgrade using Hugo
|
### 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
|
```shell
|
||||||
hugo mod get -u
|
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).
|
Once the theme has been upgraded, continue to the [next section](#step-3-theme-configuration).
|
||||||
|
|
||||||
### Upgrade using git
|
### Upgrade using git
|
||||||
|
|
2
go.mod
2
go.mod
|
@ -1,3 +1,3 @@
|
||||||
module github.com/jpanther/congo
|
module github.com/jpanther/congo/v2
|
||||||
|
|
||||||
go 1.16
|
go 1.16
|
||||||
|
|
|
@ -7,6 +7,6 @@
|
||||||
<div
|
<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"
|
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>
|
</div>
|
||||||
</details>
|
</details>
|
||||||
|
|
|
@ -1,12 +1,12 @@
|
||||||
{
|
{
|
||||||
"name": "hugo-congo-theme",
|
"name": "hugo-congo-theme",
|
||||||
"version": "1.6.4",
|
"version": "2.0.0",
|
||||||
"lockfileVersion": 2,
|
"lockfileVersion": 2,
|
||||||
"requires": true,
|
"requires": true,
|
||||||
"packages": {
|
"packages": {
|
||||||
"": {
|
"": {
|
||||||
"name": "hugo-congo-theme",
|
"name": "hugo-congo-theme",
|
||||||
"version": "1.6.4",
|
"version": "2.0.0",
|
||||||
"hasInstallScript": true,
|
"hasInstallScript": true,
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
|
@ -354,9 +354,9 @@
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"node_modules/caniuse-lite": {
|
"node_modules/caniuse-lite": {
|
||||||
"version": "1.0.30001304",
|
"version": "1.0.30001305",
|
||||||
"resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001304.tgz",
|
"resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001305.tgz",
|
||||||
"integrity": "sha512-bdsfZd6K6ap87AGqSHJP/s1V+U6Z5lyrcbBu3ovbCCf8cSYpwTtGrCBObMpJqwxfTbLW6YTIdbb1jEeTelcpYQ==",
|
"integrity": "sha512-p7d9YQMji8haf0f+5rbcv9WlQ+N5jMPfRAnUmZRlNxsNeBO3Yr7RYG6M2uTY1h9tCVdlkJg6YNNc4kiAiBLdWA==",
|
||||||
"dev": true,
|
"dev": true,
|
||||||
"peer": true,
|
"peer": true,
|
||||||
"funding": {
|
"funding": {
|
||||||
|
@ -1294,9 +1294,9 @@
|
||||||
"dev": true
|
"dev": true
|
||||||
},
|
},
|
||||||
"node_modules/electron-to-chromium": {
|
"node_modules/electron-to-chromium": {
|
||||||
"version": "1.4.57",
|
"version": "1.4.63",
|
||||||
"resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.4.57.tgz",
|
"resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.4.63.tgz",
|
||||||
"integrity": "sha512-FNC+P5K1n6pF+M0zIK+gFCoXcJhhzDViL3DRIGy2Fv5PohuSES1JHR7T+GlwxSxlzx4yYbsuzCZvHxcBSRCIOw==",
|
"integrity": "sha512-e0PX/LRJPFRU4kzJKLvTobxyFdnANCvcoDCe8XcyTqP58nTWIwdsHvXLIl1RkB39X5yaosLaroMASWB0oIsgCA==",
|
||||||
"dev": true,
|
"dev": true,
|
||||||
"peer": true
|
"peer": true
|
||||||
},
|
},
|
||||||
|
@ -1877,15 +1877,15 @@
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"node_modules/postcss": {
|
"node_modules/postcss": {
|
||||||
"version": "8.4.5",
|
"version": "8.4.6",
|
||||||
"resolved": "https://registry.npmjs.org/postcss/-/postcss-8.4.5.tgz",
|
"resolved": "https://registry.npmjs.org/postcss/-/postcss-8.4.6.tgz",
|
||||||
"integrity": "sha512-jBDboWM8qpaqwkMwItqTQTiFikhs/67OYVvblFFTM7MrZjt6yMKd6r2kgXizEbTTljacm4NldIlZnhbjr84QYg==",
|
"integrity": "sha512-OovjwIzs9Te46vlEx7+uXB0PLijpwjXGKXjVGGPIGubGpq7uh5Xgf6D6FiJ/SzJMBosHDp6a2hiXOS97iBXcaA==",
|
||||||
"dev": true,
|
"dev": true,
|
||||||
"peer": true,
|
"peer": true,
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"nanoid": "^3.1.30",
|
"nanoid": "^3.2.0",
|
||||||
"picocolors": "^1.0.0",
|
"picocolors": "^1.0.0",
|
||||||
"source-map-js": "^1.0.1"
|
"source-map-js": "^1.0.2"
|
||||||
},
|
},
|
||||||
"engines": {
|
"engines": {
|
||||||
"node": "^10 || ^12 || >=14"
|
"node": "^10 || ^12 || >=14"
|
||||||
|
@ -2535,9 +2535,9 @@
|
||||||
"dev": true
|
"dev": true
|
||||||
},
|
},
|
||||||
"caniuse-lite": {
|
"caniuse-lite": {
|
||||||
"version": "1.0.30001304",
|
"version": "1.0.30001305",
|
||||||
"resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001304.tgz",
|
"resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001305.tgz",
|
||||||
"integrity": "sha512-bdsfZd6K6ap87AGqSHJP/s1V+U6Z5lyrcbBu3ovbCCf8cSYpwTtGrCBObMpJqwxfTbLW6YTIdbb1jEeTelcpYQ==",
|
"integrity": "sha512-p7d9YQMji8haf0f+5rbcv9WlQ+N5jMPfRAnUmZRlNxsNeBO3Yr7RYG6M2uTY1h9tCVdlkJg6YNNc4kiAiBLdWA==",
|
||||||
"dev": true,
|
"dev": true,
|
||||||
"peer": true
|
"peer": true
|
||||||
},
|
},
|
||||||
|
@ -3312,9 +3312,9 @@
|
||||||
"dev": true
|
"dev": true
|
||||||
},
|
},
|
||||||
"electron-to-chromium": {
|
"electron-to-chromium": {
|
||||||
"version": "1.4.57",
|
"version": "1.4.63",
|
||||||
"resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.4.57.tgz",
|
"resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.4.63.tgz",
|
||||||
"integrity": "sha512-FNC+P5K1n6pF+M0zIK+gFCoXcJhhzDViL3DRIGy2Fv5PohuSES1JHR7T+GlwxSxlzx4yYbsuzCZvHxcBSRCIOw==",
|
"integrity": "sha512-e0PX/LRJPFRU4kzJKLvTobxyFdnANCvcoDCe8XcyTqP58nTWIwdsHvXLIl1RkB39X5yaosLaroMASWB0oIsgCA==",
|
||||||
"dev": true,
|
"dev": true,
|
||||||
"peer": true
|
"peer": true
|
||||||
},
|
},
|
||||||
|
@ -3765,15 +3765,15 @@
|
||||||
"dev": true
|
"dev": true
|
||||||
},
|
},
|
||||||
"postcss": {
|
"postcss": {
|
||||||
"version": "8.4.5",
|
"version": "8.4.6",
|
||||||
"resolved": "https://registry.npmjs.org/postcss/-/postcss-8.4.5.tgz",
|
"resolved": "https://registry.npmjs.org/postcss/-/postcss-8.4.6.tgz",
|
||||||
"integrity": "sha512-jBDboWM8qpaqwkMwItqTQTiFikhs/67OYVvblFFTM7MrZjt6yMKd6r2kgXizEbTTljacm4NldIlZnhbjr84QYg==",
|
"integrity": "sha512-OovjwIzs9Te46vlEx7+uXB0PLijpwjXGKXjVGGPIGubGpq7uh5Xgf6D6FiJ/SzJMBosHDp6a2hiXOS97iBXcaA==",
|
||||||
"dev": true,
|
"dev": true,
|
||||||
"peer": true,
|
"peer": true,
|
||||||
"requires": {
|
"requires": {
|
||||||
"nanoid": "^3.1.30",
|
"nanoid": "^3.2.0",
|
||||||
"picocolors": "^1.0.0",
|
"picocolors": "^1.0.0",
|
||||||
"source-map-js": "^1.0.1"
|
"source-map-js": "^1.0.2"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"postcss-js": {
|
"postcss-js": {
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
{
|
{
|
||||||
"name": "hugo-congo-theme",
|
"name": "hugo-congo-theme",
|
||||||
"version": "2.0.0",
|
"version": "2.0.1",
|
||||||
"description": "Congo theme for Hugo",
|
"description": "Congo theme for Hugo",
|
||||||
"main": "index.js",
|
"main": "index.js",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
|
|
Loading…
Reference in New Issue