From fe7fd97e6c8e265756d5bdae225db723dc18280f Mon Sep 17 00:00:00 2001 From: "P. Ottlinger" Date: Fri, 31 Mar 2023 21:42:03 +0200 Subject: [PATCH] #128: Introduce changelog and update recent changes (#130) * #126: Add issue to changelist * #128: Add base CHANGELOG * Issue #128, #126: Add first entries * Link to issue * #128: Adapt contribution guidelines to new Changelog * #128: Tweak README to include changelog * #128: Fix link to changes * Issues #126, #129, #128: Add changelog entries * #128: Add entries for past PRs * #128: Remove extra section to changelog * #128: Rename as suggested * #128: Make link to changelog relative to work in forks/PRs --- CHANGELOG.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++ README.md | 13 +++++++++---- contributing.md | 17 ++++++++++++++--- 3 files changed, 70 insertions(+), 7 deletions(-) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..63ebd1e --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,47 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +* Added for new features. +* Changed for changes in existing functionality. +* Deprecated for soon-to-be removed features. +* Removed for now removed features. +* Fixed for any bug fixes. +* Security in case of vulnerabilities. + +# KNOWN ISSUES +* not yet known + +## [Unreleased](https://github.com/zjedi/hugo-scroll/compare/v1.0.0...HEAD) + +### Added +* 2023-03: [#126](https://github.com/zjedi/hugo-scroll/issues/126) Add version information to site's footer by setting the general configuration option `enableGitInfo=true`. +* 2023-03: [#129](https://github.com/zjedi/hugo-scroll/pull/129) External links may contain icons as well, set attribute `icon` accordingly. +* 2023-03: [#99](https://github.com/zjedi/hugo-scroll/pull/99) Add shortcode `extlink` to allow external links. +### Changed +* 2023-03: [#109](https://github.com/zjedi/hugo-scroll/pull/109) Transfer repository of this theme to new Github coordinates: https://github.com/zjedi/hugo-scroll +* 2023-03: [#121](https://github.com/zjedi/hugo-scroll/pull/121) Always open reference link to this theme in a new tab +* 2023-03: [#106](https://github.com/zjedi/hugo-scroll/pull/106) Changes in layout and style. + +### Deprecated +### Removed +### Fixed +* 2023-03: Cleanup generated markup: do not render empty `
` in footer. +* 2023-03: [#122](https://github.com/zjedi/hugo-scroll/pull/122) Update docs to allow plain HTML in configurable footer copyright line; no markdown supported anymore. + +### Security + + + +# Template for new releases +## [x.y.z](https://github.com/zjedi/hugo-scroll/compare/v1.0.0...vx.y.z) + +### Added +### Changed +### Deprecated +### Removed +### Fixed +### Security diff --git a/README.md b/README.md index 5536643..b445177 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,12 @@ # Hugo Scroll A [Hugo](https://gohugo.io/) theme for pretty, quick and simple single-page websites. -For live demo of master branch, please visit https://zjedi.github.io/hugo-scroll/. ![Test](https://github.com/zjedi/hugo-scroll/workflows/CI/badge.svg?branch=master&event=push) +## Live demo + +The current default branch is automatically deployed and can be seen at https://zjedi.github.io/hugo-scroll/. + As a fallback, see a screenshot which may be a bit outdated: ![Screenshot Hugo Scroll Theme](https://raw.githubusercontent.com/zjedi/hugo-scroll/master/images/tn.png) ## Installation @@ -13,6 +16,8 @@ git submodule add https://github.com/zjedi/hugo-scroll.git themes/hugo-scroll ``` Then, adjust the `config.toml` as detailed below & in the file comments. +### Playing around with our example site + If you simply want to check out the `exampleSite`, you can run ``` git clone https://github.com/zjedi/hugo-scroll.git hugo-scroll @@ -43,7 +48,7 @@ Configured in `_index.md`, see `exampleSite`: `header_logo: "images/chef-hat.png In order to see technical version information (extracted from Hugo's [GitInfo](https://gohugo.io/variables/git/))) set the following general option in your config.toml: `enableGitInfo = true` ### External links -You can add external links in the menu, see `external.md` in the `exampleSite`. +You can add an external link in the menu, see `external.md` in the `exampleSite`. You can also use `extlink` shortcode to create a link opening in a new tab: ```markdown @@ -58,8 +63,8 @@ Visit as at {{