Spellcheck and linter fixes

Signed-off-by: Daniel Holbach <daniel.holbach@gmail.com>
This commit is contained in:
Daniel Holbach 2024-03-19 21:42:40 +01:00 committed by zjedi
parent d336a31c1e
commit 9e4ffcda5e
6 changed files with 48 additions and 23 deletions

View file

@ -14,18 +14,24 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [Unreleased](https://github.com/zjedi/hugo-scroll/compare/v.1.0.0...master) ## [Unreleased](https://github.com/zjedi/hugo-scroll/compare/v.1.0.0...master)
- **JS cleanup / CSS refactoring**, possibly causing some pain if you have extensive CSS customisations in screen.css #4, #61, #102. For backwards compatibility, a released tag` v1.0.0` was created just in case some projects needed to fix the legacy version. However, I won't actively support the legacy branch. * **JS cleanup / CSS refactoring**, possibly causing some pain if you have extensive CSS customisations in screen.css #4, #61, #102. For backwards compatibility, a released tag` v1.0.0` was created just in case some projects needed to fix the legacy version. However, I won't actively support the legacy branch.
- New features: #70 , #46 , #118 * New features: #70 , #46 , #118
- More features #116 , #119 * More features #116 , #119
## [1.0.0 Legacy Snapshot](https://github.com/zjedi/hugo-scroll/releases/tag/v.1.0.0) ## [1.0.0 Legacy Snapshot](https://github.com/zjedi/hugo-scroll/releases/tag/v.1.0.0)
# Template for new releases ## Template for new releases
## [x.y.z](https://github.com/zjedi/hugo-scroll/compare/v1.0.0...vx.y.z) ## [x.y.z](https://github.com/zjedi/hugo-scroll/compare/v1.0.0...vx.y.z)
### Added ### Added
### Changed ### Changed
### Deprecated ### Deprecated
### Removed ### Removed
### Fixed ### Fixed
### Security ### Security

View file

@ -12,6 +12,7 @@ Promo image which may be a bit outdated:<br/>
![Screenshot Hugo Scroll Theme](https://raw.githubusercontent.com/zjedi/hugo-scroll/master/images/tn.png) ![Screenshot Hugo Scroll Theme](https://raw.githubusercontent.com/zjedi/hugo-scroll/master/images/tn.png)
## ⭐ Feature highlights ## ⭐ Feature highlights
- Responsive to screen size/shape - Responsive to screen size/shape
- SEO friendly - SEO friendly
- Customizable - Customizable
@ -20,22 +21,26 @@ Promo image which may be a bit outdated:<br/>
- Header logo - Header logo
- Visual guards to guarantee readability - Visual guards to guarantee readability
- External links - External links
- JS/CSS Assets optimized (Minification, Fingerpriting, pipeline-processed - JS/CSS Assets optimized (Minification, Fingerprinting, pipeline-processed
into single file) into single file)
- git info in footer (opt-in) - git info in footer (opt-in)
## 🔑 Installation ## 🔑 Installation
You need to install Hugo extended version. You need to install Hugo extended version.
If you already have a Hugo site on your machine, you can simply add this theme via If you already have a Hugo site on your machine, you can simply add this theme via
```
```cli
git submodule add https://github.com/zjedi/hugo-scroll.git themes/hugo-scroll 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. Then, adjust the `config.toml` as detailed below & in the file comments.
### Playing around with our example site ### Playing around with our example site
If you simply want to check out the `exampleSite`, you can run If you simply want to check out the `exampleSite`, you can run
```
```cli
git clone https://github.com/zjedi/hugo-scroll.git hugo-scroll git clone https://github.com/zjedi/hugo-scroll.git hugo-scroll
cd hugo-scroll cd hugo-scroll
hugo server --source=exampleSite --themesDir=../.. hugo server --source=exampleSite --themesDir=../..
@ -51,60 +56,73 @@ You can add **a new section to the homepage** by running `hugo new homepage/my-n
To create **a page separate from the homepage**, run `hugo new my-new-page.md` To create **a page separate from the homepage**, run `hugo new my-new-page.md`
## 🔧 Feature details 🔨 ## 🔧 Feature details 🔨
### Customizing CSS ### Customizing CSS
Add a [`custom_head.html`](https://github.com/zjedi/hugo-scroll/blob/master/exampleSite/layouts/partials/custom_head.html) file to your `layouts/partials` directory.
Add a [`custom_head.html`](https://github.com/zjedi/hugo-scroll/blob/master/exampleSite/layouts/partials/custom_head.html) file to your `layouts/partials` directory.
- You can use `<style>` tag to embed the overrides (better performance-wise) - You can use `<style>` tag to embed the overrides (better performance-wise)
- Alternatively you can `<link>` your own `custom.css` - Alternatively you can `<link>` your own `custom.css`
`CSS` variables `var(--some-var-name)` from `assets\css\variables.scss` can be overridden by adding `CSS` variables `var(--some-var-name)` from `assets\css\variables.scss` can be overridden by adding
```scss ```scss
:root { :root {
--some-var-name: blue!important; --some-var-name: blue!important;
} }
``` ```
### Icons ### Icons
This theme includes the full set of [Fork Awesome 1.2.0 Icons][fork-awesome-icons]. Use the `{{<icon>}}`-[shortcode][hugo-shortcodes] with the respective "fa fa-ICONNAME"-`class` to use an icon directly in your `.markdown` files à la This theme includes the full set of [Fork Awesome 1.2.0 Icons][fork-awesome-icons]. Use the `{{<icon>}}`-[shortcode][hugo-shortcodes] with the respective "fa fa-ICONNAME"-`class` to use an icon directly in your `.markdown` files à la
```markdown ```markdown
Look at this nice »envelope«-icon: `{{<icon class="fa fa-envelope">}}`. I took this from https://forkaweso.me/Fork-Awesome/icon/envelope/ :-) Look at this nice »envelope«-icon: `{{<icon class="fa fa-envelope">}}`. I took this from https://forkaweso.me/Fork-Awesome/icon/envelope/ :-)
``` ```
### Header logo ### Header logo
Configured in `_index.md`, see `exampleSite`: `header_logo: "images/chef-hat.png"` Configured in `_index.md`, see `exampleSite`: `header_logo: "images/chef-hat.png"`
### Video cover ### Video cover
Set `header_use_video: true` in `/exampleSite/content/_index.md` and define video source via custom partial, such as `exampleSite/layouts/partials/custom_header_video.html`. Set `header_use_video: true` in `/exampleSite/content/_index.md` and define video source via custom partial, such as `exampleSite/layouts/partials/custom_header_video.html`.
### Footer version information ### Footer version information
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` 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 ### External links
You can add an external link 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: You can also use `extlink` shortcode to create a link opening in a new tab:
```markdown ```markdown
Visit as at {{<extlink text="Instagram" href="https://www.instagram.com/yourInstagramName/">}} Visit us at {{<extlink text="Instagram" href="https://www.instagram.com/yourInstagramName/">}}
``` ```
Referencing and showing icons in front of the link text is possible with a new parameter `icon`: Referencing and showing icons in front of the link text is possible with a new parameter `icon`:
```markdown ```markdown
Visit as at {{<extlink icon="fa fa-instagram" text="Instagram" href="https://www.instagram.com/yourInstagramName/">}} Visit us at {{<extlink icon="fa fa-instagram" text="Instagram" href="https://www.instagram.com/yourInstagramName/">}}
``` ```
## 🐛 Issues / 💡 Feedback / 👑 Contributing ## 🐛 Issues / 💡 Feedback / 👑 Contributing
[Discussion](https://github.com/zjedi/hugo-scroll/discussions) for Q&A (when unsure),
[Discussion](https://github.com/zjedi/hugo-scroll/discussions) for Q&A (when unsure),
[Issues](https://github.com/zjedi/hugo-scroll/issues) for tracking, [Issues](https://github.com/zjedi/hugo-scroll/issues) for tracking,
[Pull Requests](https://github.com/zjedi/hugo-scroll/pulls) for contributions. [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. See [contributing guideline](https://github.com/zjedi/hugo-scroll/blob/master/contributing.md) for more.
## 👏 Special Thanks ## 👏 Special Thanks
- [Jan Raasch](https://www.janraasch.com), original author of theme - [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. - [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 _free_ stock photos. - [Pexels](https://www.pexels.com), for supplying _free_ stock photos.
[hugo-setup-guide]: https://gohugo.io/getting-started/installing [hugo-setup-guide]: https://gohugo.io/getting-started/installing
[fork-awesome-icons]: https://forkaweso.me/Fork-Awesome/icons/ [fork-awesome-icons]: https://forkaweso.me/Fork-Awesome/icons/
[hugo-shortcodes]: https://gohugo.io/content-management/shortcodes/ [hugo-shortcodes]: https://gohugo.io/content-management/shortcodes/

View file

@ -1,4 +1,5 @@
## [Pull Requests](https://github.com/zjedi/hugo-scroll/pulls) # [Pull Requests](https://github.com/zjedi/hugo-scroll/pulls)
We're open to contributions by opening a pull request. We're open to contributions by opening a pull request.
When adding a new feature, please modify also [exampleSite](./exampleSite/) with an example of how the feature can be activated, configured and used. When adding a new feature, please modify also [exampleSite](./exampleSite/) with an example of how the feature can be activated, configured and used.
@ -12,6 +13,7 @@ Alternatively you may use GitHub issues for more complex topics and features.
## [Changelog](./CHANGELOG.md) ## [Changelog](./CHANGELOG.md)
Feel free to add your contributions to our CHANGELOG, which tracks: Feel free to add your contributions to our CHANGELOG, which tracks:
* **Added** for new features. * **Added** for new features.
* **Changed** for changes in existing functionality. * **Changed** for changes in existing functionality.
* **Deprecated** for soon-to-be removed features. * **Deprecated** for soon-to-be removed features.

View file

@ -7,5 +7,3 @@ In this section we give credit to authors of resources used on this demo page.
- {{<extlink text="Chef-hat icons created by Cuputo - Flaticon" href="https://www.flaticon.com/free-icons/chef-hat" icon="fa fa-external-link">}} - {{<extlink text="Chef-hat icons created by Cuputo - Flaticon" href="https://www.flaticon.com/free-icons/chef-hat" icon="fa fa-external-link">}}
- {{<extlink text="sprinkle-of-rock-salt-on-sliced-vegetables-3209239 - Pexels" href="https://www.pexels.com/video/sprinkle-of-rock-salt-on-sliced-vegetables-3209239/" icon="fa fa-external-link">}} - {{<extlink text="sprinkle-of-rock-salt-on-sliced-vegetables-3209239 - Pexels" href="https://www.pexels.com/video/sprinkle-of-rock-salt-on-sliced-vegetables-3209239/" icon="fa fa-external-link">}}

View file

@ -3,12 +3,12 @@ title: "Welcome"
weight: 1 weight: 1
--- ---
`Hugo-Scroll` theme alternates colors of sections that are placed on single page. `Hugo-Scroll` theme alternates colors of sections that are placed on single page.
The landing screen is meant to be visually striking. The landing screen is meant to be visually striking.
Single-page approach is oriented towards small to medium content length, that won't overwhelm the user. Single-page approach is oriented towards small to medium content length, that won't overwhelm the user.
You can also delegate lengthier, less important or more sizeable content to [dedicated pages](services). You can also delegate lengthier, less important or more sizeable content to [dedicated pages](services).
> The belly rules the mind. --- spanish proverb > The belly rules the mind. --- spanish proverb
By the way this welcome section won't show in the cover menu. By the way this welcome section won't show in the cover menu.

View file

@ -7,6 +7,7 @@ header_menu: true
--- ---
Feature notice: This section displays options to customize title: Feature notice: This section displays options to customize title:
- has a normal section title (`title` = "The Services I Offer"), - has a normal section title (`title` = "The Services I Offer"),
- custom welcome screen title (`header_menu_title` = "Services"), - custom welcome screen title (`header_menu_title` = "Services"),
- custom navigation menu title (`navigation_menu_title` = "My Services"). - custom navigation menu title (`navigation_menu_title` = "My Services").
@ -17,7 +18,7 @@ That is the important part, right? You want to know what I can do for you. This
### Nutrition Coaching ### Nutrition Coaching
This is not an easy task. This is not an easy task.
You will likely have to pay money for this. You will likely have to pay money for this.
### Chef Consulting ### Chef Consulting
@ -26,4 +27,4 @@ I can raise your table culture!
![Let us get started on a clean slate](images/woman-pouring-juice-on-glass-3184192.jpg) ![Let us get started on a clean slate](images/woman-pouring-juice-on-glass-3184192.jpg)
Want to learn more about my services? See [dedicated page](services) with more details. Want to learn more about my services? See [dedicated page](services) with more details.