diff --git a/CHANGELOG.md b/CHANGELOG.md index 61c3b8d..c8a602a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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 diff --git a/README.md b/README.md index 2d23c9a..97a9dff 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,7 @@ Promo image which may be a bit outdated:
![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:
- 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. + +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 `