Skip to content

Commit

Permalink
Updated promo image, minor changes in .md files
Browse files Browse the repository at this point in the history
  • Loading branch information
zjedi committed Mar 31, 2023
1 parent fe7fd97 commit 67c8ca2
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 29 deletions.
19 changes: 4 additions & 15 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,28 +12,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
* 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.
* 2023-03: [#106](https://github.com/zjedi/hugo-scroll/pull/106) title_guard feature, color made more contrasting
### 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 `<section>` 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

* Moved CSS & JS from `static` to `assets`, used pipelined concatenation, minification fingerprinting
* 2023-03: [#109](https://github.com/zjedi/hugo-scroll/pull/109) Transfer repository ownership: https://github.com/zjedi/hugo-scroll
* 2023-03: [#122](https://github.com/zjedi/hugo-scroll/pull/122) Plain HTML in header & footer; Markdown not supported anymore.


# Template for new releases
Expand Down
22 changes: 12 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Hugo Scroll
A [Hugo](https://gohugo.io/) theme for pretty, quick and simple single-page websites.
<h1 align=center>Hugo Scroll <a href="https://zjedi.github.io/hugo-scroll/" rel="nofollow">Demo</a></h1>

![Test](https://github.com/zjedi/hugo-scroll/workflows/CI/badge.svg?branch=master&event=push)

## Live demo
Clean, responsive, single-page [Hugo](https://gohugo.io/) website theme.

The current default branch is automatically deployed and can be seen at https://zjedi.github.io/hugo-scroll/.
[![hugo-scroll](https://img.shields.io/badge/Hugo--Themes-HugoScroll-blue)](https://themes.gohugo.io/themes/hugo-scroll/)
![Test](https://github.com/zjedi/hugo-scroll/workflows/CI/badge.svg?branch=master&event=push)
[![GitHub](https://img.shields.io/github/license/zjedi/hugo-scroll)](https://github.com/zjedi/hugo-scroll/blob/master/LICENSE)

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)
Promo image which may be a bit outdated:<br/>
![Screenshot Hugo Scroll Theme](https://raw.githubusercontent.com/zjedi/hugo-scroll/master/images/tn.png)

## Installation
If you already have a Hugo site on your machine, you can simply add this theme via
Expand Down Expand Up @@ -63,16 +63,18 @@ Visit as at {{<extlink icon="fa fa-instagram" text="Instagram" href="https://www
Add a `custom_head.html`-file to your `layouts/partials`-directory. In there you may add a `<style>`-tag _or_ you may add a `<link>`-tag referencing your own `custom.css` (in case you prefer to have a separate `.css`-file). Checkout the [`custom_head.html`](https://github.com/zjedi/hugo-scroll/blob/master/exampleSite/layouts/partials/custom_head.html)-file from the `exampleSite`-directory to get started and to find more detailed instructions.

## Issues / Feedback / Contributing
Please use [GitHub issues](https://github.com/zjedi/hugo-scroll/issues) and [Pull Requests](https://github.com/zjedi/hugo-scroll/pulls).
[Discussion](https://github.com/zjedi/hugo-scroll/discussions) for Q&A (when unsure),
[Issues](https://github.com/zjedi/hugo-scroll/issues) for tracking,
[Pull Requests](https://github.com/zjedi/hugo-scroll/pulls) for contributions.


See [contributing guideline](https://github.com/zjedi/hugo-scroll/blob/master/contributing.md) for more.

## Special Thanks 🎁
- [Jan Raasch](https://www.janraasch.com), original author of theme
- [Yonatan Wolowelsky](https://github.com/grmmph), author of [GhostScroll](https://github.com/grmmph/GhostScroll) theme, which formed the basis of this [Hugo](https://gohugo.io/) theme.
- [Pexels](https://www.pexels.com), for supplying those wonderful _free_ stock photos on the [exampleSite](https://github.com/zjedi/hugo-scroll/tree/master/exampleSite).

## License
[MIT License](http://en.wikipedia.org/wiki/MIT_License)

[hugo-setup-guide]: https://gohugo.io/getting-started/installing
[fork-awesome-icons]: https://forkaweso.me/Fork-Awesome/icons/
Expand Down
4 changes: 0 additions & 4 deletions exampleSite/content/homepage/opener.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,3 @@ weight: 1
---

Hi there. This section will not show up in the header menu above. Other than that, there's really not much to see here. I did however append some generated »Lorem ipsum«-paragraphs for you. Enjoy!

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus vehicula turpis nec arcu cursus, ac faucibus felis tempor. Donec molestie arcu eu pretium accumsan. Phasellus urna nisi, volutpat pharetra orci vel, feugiat sollicitudin diam. Phasellus dolor tortor, feugiat a ipsum id, gravida volutpat urna. Nam dictum nulla ac nisi aliquam ultricies. Nam tempus eget lorem vitae vulputate.

Nulla aliquet, nisl pulvinar fermentum ultricies, turpis purus ultricies lorem, ut faucibus arcu nisl in tellus. Integer eu augue auctor, fringilla nunc ut, finibus eros. Curabitur est lectus, ultricies id blandit at, malesuada et ipsum. Suspendisse potenti. Quisque euismod sapien arcu, vel sollicitudin ipsum dignissim nec.
Binary file modified images/tn.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 67c8ca2

Please sign in to comment.