yann/hugo-scroll
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Spellcheck and linter fixes

Browse source 
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
Show stats Download patch file Download diff file Expand all files Collapse all files

14
CHANGELOG.md
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)
- **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
- More features #116 , #119
* **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
* More features #116 , #119
## [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)
### Added
### Changed
### Deprecated
### Removed
### Fixed
### Security

34
README.md
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)
## ⭐ Feature highlights
- Responsive to screen size/shape
- SEO friendly
- Customizable
@ -20,22 +21,26 @@ Promo image which may be a bit outdated:<br/>
- Header logo
- Visual guards to guarantee readability
- External links
- JS/CSS Assets optimized (Minification, Fingerpriting, pipeline-processed
- JS/CSS Assets optimized (Minification, Fingerprinting, pipeline-processed
into single file)
- git info in footer (opt-in)
## 🔑 Installation
You need to install Hugo extended version.
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
```
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
```
```cli
git clone https://github.com/zjedi/hugo-scroll.git hugo-scroll
cd hugo-scroll
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`
## 🔧 Feature details 🔨
### 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.
- You can use `<style>` tag to embed the overrides (better performance-wise)
- Alternatively you can `<link>` your own `custom.css`
`CSS` variables `var(--some-var-name)` from `assets\css\variables.scss` can be overridden by adding
```scss
:root {
--some-var-name: blue!important;
}
```
### 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
```markdown
Look at this nice »envelope«-icon: `{{<icon class="fa fa-envelope">}}`. I took this from https://forkaweso.me/Fork-Awesome/icon/envelope/ :-)
```
### Header logo
Configured in `_index.md`, see `exampleSite`: `header_logo: "images/chef-hat.png"`
### 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`.
### 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`
### External links
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
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`:
```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
[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 _free_ stock photos.
[hugo-setup-guide]: https://gohugo.io/getting-started/installing
[fork-awesome-icons]: https://forkaweso.me/Fork-Awesome/icons/
[hugo-shortcodes]: https://gohugo.io/content-management/shortcodes/

4
contributing.md
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.
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)
Feel free to add your contributions to our CHANGELOG, which tracks:
* **Added** for new features.
* **Changed** for changes in existing functionality.
* **Deprecated** for soon-to-be removed features.

2
exampleSite/content/homepage/credits.md
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="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">}}

1
exampleSite/content/homepage/services.md
View file

@ -7,6 +7,7 @@ header_menu: true
---
Feature notice: This section displays options to customize title:
- has a normal section title (`title` = "The Services I Offer"),
- custom welcome screen title (`header_menu_title` = "Services"),
- custom navigation menu title (`navigation_menu_title` = "My Services").