diff --git a/.stylelintignore b/.stylelintignore index 353b7e8c..9d9a3cec 100644 --- a/.stylelintignore +++ b/.stylelintignore @@ -1,2 +1,2 @@ -assets/sass/vendor +assets/scss/vendor node_modules \ No newline at end of file diff --git a/.travis.yml b/.travis.yml index 24bf5117..2f60d907 100644 --- a/.travis.yml +++ b/.travis.yml @@ -4,6 +4,7 @@ sudo: required language: node_js node_js: - "lts/*" + - "13" install: - wget "https://github.com/gohugoio/hugo/releases/download/v${HUGO_RELEASE}/hugo_extended_${HUGO_RELEASE}_Linux-64bit.deb" @@ -19,4 +20,4 @@ script: env: global: - PRODUCTION=true - - HUGO_RELEASE=0.60.1 \ No newline at end of file + - HUGO_RELEASE=0.69.0 \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index e74e0cfd..f2fd3066 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +## [1.2.2] - 2020-04-17 +### Added +- `[[module.mounts]]` to `config/_default/config.toml` + +### Changed +- Bumped `[build.environment]` `netlify.toml` +- `.travis.yml` +- `README` +- `index.headers` + +### Removed +- `copy:deps` from build command + ## [1.2.1] - 2020-03-31 ### Added - version to package.json - [issue 23](https://github.com/h-enk/hyas/issues/23) @@ -68,7 +81,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - lazysizes 5.2.0-beta1 - [Atlas](https://github.com/indigotree/atlas), Copyright (c) 2017 Indigo Tree, [MIT License](https://github.com/indigotree/atlas/blob/master/LICENSE) -[Unreleased]: https://github.com/h-enk/hyas/compare/v1.2.1...HEAD +[Unreleased]: https://github.com/h-enk/hyas/compare/v1.2.2...HEAD +[1.2.2]: https://github.com/h-enk/hyas/releases/tag/v1.2.2 [1.2.1]: https://github.com/h-enk/hyas/releases/tag/v1.2.1 [1.2.0]: https://github.com/h-enk/hyas/releases/tag/v1.2.0 [1.1.0]: https://github.com/h-enk/hyas/releases/tag/v1.1.0 diff --git a/README.md b/README.md index 537693db..16eeb2b4 100644 --- a/README.md +++ b/README.md @@ -3,27 +3,32 @@ [![Build Status](https://img.shields.io/travis/h-enk/hyas.svg?style=flat-square)](https://travis-ci.org/h-enk/hyas) [![Netlify](https://img.shields.io/netlify/895a161c-86be-48a2-8c57-a8c5d68cd1a4?style=flat-square)](https://hyas.netlify.com/) -Hugo boilerplate helping you build fast, robust, and adaptable websites. +Hyas is a Hugo starter helping you build modern websites. ## Features - -- Bootstrap Sass (no JavaScript) and Autoprefixer -- Check Sass and JavaScript for errors +- Lightweight code base +- 100 scores Google Lighthouse +- A+ scores [Mozilla Observatory](https://observatory.mozilla.org/) +- Easily make it your own +- [Bootstrap](https://getbootstrap.com/docs/4.4/getting-started/download/#source-files) Sass (no JavaScript) and [Autoprefixer](https://github.com/postcss/autoprefixer) +- Check SCSS for errors with [stylelint](https://stylelint.io/) +- Check JavaScript for errors with [ESLint](https://eslint.org/) - Environment specific configuration - Image shortcode with [lazysizes](https://github.com/aFarkas/lazysizes) and [blur up](https://github.com/aFarkas/lazysizes/tree/master/plugins/blur-up) plugin - Fingerprinting and [SRI](https://developer.mozilla.org/en-US/docs/Web/Security/Subresource_Integrity) (production) -- Remove unused CSS (production) +- Remove unused CSS (production) with [PurgeCSS](https://github.com/FullHuman/purgecss) + +See a working example at [hyas.netlify.app](https://hyas.netlify.app/) ## Requirements Make sure all dependencies have been installed: -- Hugo >= 0.68.3/extended -- Node.js >= 13.11.0 -- npm >= 6.13.7 -- Yarn >= 1.22.0 (recommended) +- [Hugo](https://gohugo.io/) >= 0.69.0/extended +- [Node.js](https://nodejs.org/) >= 13.11.0 +- [Yarn](https://yarnpkg.com/) >= 1.22.4 (recommended) -## Getting started +## Get started Create a new Hyas project: @@ -51,89 +56,7 @@ $ yarn start - `yarn clean` - Delete temporary directories - `yarn build` - Build production theme -## Theme structure - -```shell -my-hyas-site/ # → Root of your Hyas based theme -├── archetypes/ # → Content template files -├── assets/ # → Asset files (fonts, images, js, lambda, and sass) -├── config/ # → Configuration directives -│ ├── _default/ # → Development and defaults -│ ├── production/ # → Production specific -│ ├── staging/ # → Staging specific -│ ├── postcss.config.js # → PostCSS configuration file -├── content/ # → Content using page bundles -├── data/ # → Custom data files -├── functions/ # → Netlify lambda functions directory (production) -├── layouts/ # → Template files -│ ├── _default/ # → Base templates for list & singular pages -│ ├── partials/ # → Partials (footer, head, header, and sidebar) -│ ├── shortcodes/ # → Shortcodes (img) -│ │── 404.html # → 404 Template -│ │── index.headers # → Custom Netlify HTTP headers -│ │── index.html # → Homepage template -│ │── index.redirects # → Custom Netlify redirect rules -│ │── robots.txt # → Template for robots.txt -│ │── sitemap.xml # → Custom sitemap template -├── node_modules/ # → Node.js packages (never edit) -├── public/ # → Publish directory (temporary) -├── resources/ # → Resource cache directory (temporary) -├── static/ # → Static content (favicons et cetera) -├── .eslintrc.json # → ESLint configuration -├── .stylelintrc.json # → stylelint configuration -├── netlify.toml # → Netlify configuration -├── package.json # → Node.js dependencies and scripts -└── yarn.lock # → Yarn lock file (never edit) -``` - -## Theme setup -Edit files in `config/` directory. - - -## Theme development -### Sass - -Don't like Bootstrap? Remove it: -```bash -# @ my-hyas-site/ -$ yarn remove bootstrap -``` -Also make sure to update your sass files, like `app.scss`. - -### Images - -Use the image shortcode: -``` -{{< img src="image-in-page-bundle.jpg" alt="Text description image" caption="Caption, optional" class="wide" >}} -``` - -Configuration in `config/_default/params.toml`: - -```toml -quality = 85 -bgColor = "#fff" -landscapePhotoWidths = [900, 700, 500] -portraitPhotoWidths = [1500, 1000, 750] -lqipWidth = "20x" -``` - -### Sitemap -Exclude a page by adding the following front matter variable: -```yaml -sitemap_exclude: true -``` - -### Robots -Add a custom [robots meta tag](https://developers.google.com/search/reference/robots_meta_tag) by adding the following front matter variable: -```yaml -robots: "noindex, noarchive" -``` -This will output: - -```html - -``` ## Documentation - [Hugo](https://gohugo.io/documentation/) -- [Goldmark](https://github.com/yuin/goldmark/) +- [Hyas](https://gethyas.com/) diff --git a/archetypes/default.md b/archetypes/default.md index c192a067..383c33d5 100644 --- a/archetypes/default.md +++ b/archetypes/default.md @@ -3,5 +3,5 @@ title: "{{ replace .Name "-" " " | title }}" description: "" date: {{ .Date }} draft: true -images: [""] +images: {{ .Site.Params.images }} --- diff --git a/archetypes/news.md b/archetypes/news.md index e22239c8..c05b5269 100644 --- a/archetypes/news.md +++ b/archetypes/news.md @@ -3,7 +3,7 @@ title: "{{ replace .Name "-" " " | title }}" description: "" date: {{ .Date }} draft: true -images: [""] +images: {{ .Site.Params.images }} --- {{< img src="" alt="" caption="" class="wide" >}} diff --git a/assets/sass/app.scss b/assets/scss/app.scss similarity index 100% rename from assets/sass/app.scss rename to assets/scss/app.scss diff --git a/assets/sass/common/_global.scss b/assets/scss/common/_global.scss similarity index 100% rename from assets/sass/common/_global.scss rename to assets/scss/common/_global.scss diff --git a/assets/sass/common/_syntax.scss b/assets/scss/common/_syntax.scss similarity index 100% rename from assets/sass/common/_syntax.scss rename to assets/scss/common/_syntax.scss diff --git a/assets/sass/common/_variables.scss b/assets/scss/common/_variables.scss similarity index 100% rename from assets/sass/common/_variables.scss rename to assets/scss/common/_variables.scss diff --git a/assets/sass/components/_buttons.scss b/assets/scss/components/_buttons.scss similarity index 100% rename from assets/sass/components/_buttons.scss rename to assets/scss/components/_buttons.scss diff --git a/assets/sass/components/_code.scss b/assets/scss/components/_code.scss similarity index 100% rename from assets/sass/components/_code.scss rename to assets/scss/components/_code.scss diff --git a/assets/sass/components/_comments.scss b/assets/scss/components/_comments.scss similarity index 100% rename from assets/sass/components/_comments.scss rename to assets/scss/components/_comments.scss diff --git a/assets/sass/components/_forms.scss b/assets/scss/components/_forms.scss similarity index 100% rename from assets/sass/components/_forms.scss rename to assets/scss/components/_forms.scss diff --git a/assets/sass/components/_images.scss b/assets/scss/components/_images.scss similarity index 100% rename from assets/sass/components/_images.scss rename to assets/scss/components/_images.scss diff --git a/assets/sass/layouts/_footer.scss b/assets/scss/layouts/_footer.scss similarity index 100% rename from assets/sass/layouts/_footer.scss rename to assets/scss/layouts/_footer.scss diff --git a/assets/sass/layouts/_header.scss b/assets/scss/layouts/_header.scss similarity index 100% rename from assets/sass/layouts/_header.scss rename to assets/scss/layouts/_header.scss diff --git a/assets/sass/layouts/_pages.scss b/assets/scss/layouts/_pages.scss similarity index 100% rename from assets/sass/layouts/_pages.scss rename to assets/scss/layouts/_pages.scss diff --git a/assets/sass/layouts/_posts.scss b/assets/scss/layouts/_posts.scss similarity index 100% rename from assets/sass/layouts/_posts.scss rename to assets/scss/layouts/_posts.scss diff --git a/assets/sass/layouts/_sidebar.scss b/assets/scss/layouts/_sidebar.scss similarity index 100% rename from assets/sass/layouts/_sidebar.scss rename to assets/scss/layouts/_sidebar.scss diff --git a/assets/sass/vendor/.gitkeep b/assets/scss/vendor/.gitkeep similarity index 100% rename from assets/sass/vendor/.gitkeep rename to assets/scss/vendor/.gitkeep diff --git a/config/_default/config.toml b/config/_default/config.toml index 6bdad666..17037b51 100644 --- a/config/_default/config.toml +++ b/config/_default/config.toml @@ -49,3 +49,17 @@ notAlternative = true changefreq = "monthly" filename = "sitemap.xml" priority = 0.5 + +[module] + [[module.mounts]] + source = "assets" + target = "assets" + [[module.mounts]] + source = "static" + target = "static" + [[module.mounts]] + source = "node_modules/lazysizes" + target = "assets/js/vendor/lazysizes" + [[module.mounts]] + source = "node_modules/ga-lite/dist" + target = "static/js/vendor/ga-lite" diff --git a/config/_default/params.toml b/config/_default/params.toml index e9511bcd..9c9d26e5 100644 --- a/config/_default/params.toml +++ b/config/_default/params.toml @@ -1,8 +1,8 @@ title = "Hyas" titleSeparator = "-" -titleAddition = "Hugo Boilerplate" -description = "Hugo boilerplate helping you build fast, robust, and adaptable websites." -images = ["image-hyas.jpg"] +titleAddition = "Modern Hugo Starter" +description = "Hugo starter helping you build modern websites." +images = ["image-hyas.png"] twitterSite = "@henkverlinde" twitterCreator = "@henkverlinde" ogLocale = "en_US" diff --git a/config/postcss.config.js b/config/postcss.config.js index c7c38770..deeb5c88 100644 --- a/config/postcss.config.js +++ b/config/postcss.config.js @@ -13,8 +13,8 @@ module.exports = { whitelist: [ 'lazyloaded', ...whitelister([ - './assets/sass/common/_syntax.scss', - './assets/sass/components/_code.scss', + './assets/scss/common/_syntax.scss', + './assets/scss/components/_code.scss', ]), ], }), diff --git a/config/production/config.toml b/config/production/config.toml index 796d80a7..2e2817ba 100644 --- a/config/production/config.toml +++ b/config/production/config.toml @@ -1,2 +1,2 @@ -baseurl = "https://hyas.netlify.com/" +baseurl = "https://hyas.netlify.app/" canonifyURLs = false diff --git a/config/staging/config.toml b/config/staging/config.toml index 3453ac0a..4d24e3d5 100644 --- a/config/staging/config.toml +++ b/config/staging/config.toml @@ -1,2 +1,2 @@ -baseurl = "https://hyas-staging.netlify.com/" +baseurl = "https://hyas-staging.netlify.app/" canonifyURLs = false diff --git a/content/_index.md b/content/_index.md index 649b193f..abab9ffa 100644 --- a/content/_index.md +++ b/content/_index.md @@ -1,8 +1,8 @@ --- title : "Hyas" -description: "Hugo boilerplate helping you build fast, robust, and adaptable websites." -date: 2019-12-02T13:47:16+01:00 +description: "Hugo starter helping you build modern websites." +date: 2020-04-17T12:18:10+00:00 draft: false -images: ["image-hyas.jpg"] -lead: "Hugo boilerplate helping you build fast, robust, and adaptable websites." +images: ["image-hyas.png"] +lead: "Hugo starter helping you build modern websites." --- diff --git a/content/news/_index.md b/content/news/_index.md index 46d6f24d..5e6e852a 100644 --- a/content/news/_index.md +++ b/content/news/_index.md @@ -1,9 +1,9 @@ --- title: "News" -description: "" -date: 2019-12-02T13:47:16+01:00 +description: "News Hyas" +date: 2020-04-17T12:17:27+00:00 draft: true -images: [""] +images: ["image-hyas.png"] robots: "noindex, noarchive" sitemap_exclude: true --- diff --git a/content/quick-start/index.md b/content/quick-start/index.md index 56763949..3cc36674 100644 --- a/content/quick-start/index.md +++ b/content/quick-start/index.md @@ -1,9 +1,9 @@ --- title: "Quick Start" description: "A quick start to using Hyas." -date: 2019-12-04T15:43:37+01:00 +date: 2020-04-17T12:17:54+00:00 draft: false -images: ["hyas.jpg"] +images: ["image-hyas.png"] --- ```bash diff --git a/layouts/_default/baseof.html b/layouts/_default/baseof.html index 7c384399..3dea4031 100644 --- a/layouts/_default/baseof.html +++ b/layouts/_default/baseof.html @@ -2,26 +2,26 @@ {{ block "head" . }}{{ partial "head/head.html" . }}{{ end }} {{ if eq .Kind "home" -}} - {{ .Scratch.Set "class" "home" }} + {{ .Scratch.Set "class" "home" -}} {{ else if eq .Kind "404" -}} - {{ .Scratch.Set "class" "error404" }} + {{ .Scratch.Set "class" "error404" -}} {{ else if eq .Kind "page" -}} - {{ .Scratch.Set "class" .Type }} - {{ .Scratch.Add "class" " single" }} + {{ .Scratch.Set "class" .Type -}} + {{ .Scratch.Add "class" " single" -}} {{ else -}} - {{ .Scratch.Set "class" .Type }} - {{ .Scratch.Add "class" " list" }} + {{ .Scratch.Set "class" .Type -}} + {{ .Scratch.Add "class" " list" -}} {{ end -}} {{ block "header" . }}{{ partial "header/header.html" . }}{{ end }}
-
- {{ block "main" . }}{{ end }} -
-
+ {{ block "main" . }}{{ end }} +
- {{ block "footer" . }}{{ partial "footer/footer.html" . }}{{ end }} + {{ if ne .Section "docs" }} + {{ block "footer" . }}{{ partial "footer/footer.html" . }}{{ end }} + {{ end }} {{ block "script-footer" . }}{{ partial "footer/script-footer.html" . }}{{ end }} \ No newline at end of file diff --git a/layouts/index.headers b/layouts/index.headers index 3fa56000..385e241e 100644 --- a/layouts/index.headers +++ b/layouts/index.headers @@ -2,8 +2,8 @@ Strict-Transport-Security: max-age=31536000; includeSubDomains; preload X-Content-Type-Options: nosniff X-XSS-Protection: 1; mode=block - Content-Security-Policy: default-src 'self'; img-src 'self' data:; object-src 'none' + Content-Security-Policy: default-src 'self'; img-src 'self' data:; script-src 'self'; style-src 'self' X-Frame-Options: SAMEORIGIN Referrer-Policy: strict-origin Feature-Policy: geolocation 'self' - Cache-Control: public, max-age=31536000 + Cache-Control: public, max-age=31536000 \ No newline at end of file diff --git a/layouts/partials/footer/footer.html b/layouts/partials/footer/footer.html index 51ee46fa..6bff2a3f 100644 --- a/layouts/partials/footer/footer.html +++ b/layouts/partials/footer/footer.html @@ -2,4 +2,4 @@

{{ .Site.Params.footer | safeHTML }}

- + \ No newline at end of file diff --git a/layouts/partials/head/resource-hints.html b/layouts/partials/head/resource-hints.html index 8983e033..57dfc2e5 100644 --- a/layouts/partials/head/resource-hints.html +++ b/layouts/partials/head/resource-hints.html @@ -1 +1 @@ - + \ No newline at end of file diff --git a/layouts/partials/head/structured-data.html b/layouts/partials/head/structured-data.html index 0098a5ff..07ff46aa 100644 --- a/layouts/partials/head/structured-data.html +++ b/layouts/partials/head/structured-data.html @@ -102,4 +102,4 @@ } }{{ end }}] } - + \ No newline at end of file diff --git a/layouts/partials/head/stylesheet.html b/layouts/partials/head/stylesheet.html index 58af9575..e5f9cc52 100644 --- a/layouts/partials/head/stylesheet.html +++ b/layouts/partials/head/stylesheet.html @@ -1,11 +1,11 @@ {{ if eq (hugo.Environment) "development" -}} - {{ $options := (dict "targetPath" "main.css" "enableSourceMap" true "includePaths" (slice "node_modules")) }} - {{ $css := resources.Get "sass/app.scss" | toCSS $options }} + {{ $options := (dict "targetPath" "main.css" "enableSourceMap" true "includePaths" (slice "node_modules")) -}} + {{ $css := resources.Get "scss/app.scss" | toCSS $options -}} {{ else -}} - {{ $options := (dict "targetPath" "main.css" "outputStyle" "compressed" "includePaths" (slice "node_modules")) }} - {{ $css := resources.Get "sass/app.scss" | toCSS $options | postCSS (dict "config" "config/postcss.config.js") }} - {{ $secureCSS := $css | resources.Fingerprint "sha512" }} + {{ $options := (dict "targetPath" "main.css" "outputStyle" "compressed" "includePaths" (slice "node_modules")) -}} + {{ $css := resources.Get "scss/app.scss" | toCSS $options | postCSS (dict "config" "config/postcss.config.js") -}} + {{ $secureCSS := $css | resources.Fingerprint "sha512" -}} {{ end -}} - + \ No newline at end of file diff --git a/netlify.toml b/netlify.toml index 568cce92..70319d00 100644 --- a/netlify.toml +++ b/netlify.toml @@ -4,10 +4,10 @@ functions = "functions/" [build.environment] - HUGO_VERSION = "0.68.3" + HUGO_VERSION = "0.69.0" NODE_VERSION = "13.11.0" NPM_VERSION = "6.13.7" - YARN_VERSION = "1.22.0" + YARN_VERSION = "1.22.4" [context.deploy-preview] command = "yarn build:preview" diff --git a/package.json b/package.json index 016e1c6f..6116c3ee 100644 --- a/package.json +++ b/package.json @@ -1,13 +1,13 @@ { "name": "hyas", - "version": "1.2.1", + "version": "1.2.2", "private": true, "browserslist": [ "defaults" ], "scripts": { "start": "hugo server", - "build": "npm run copy:deps && hugo --minify && npm run build:functions", + "build": "hugo --minify && npm run build:functions", "build:functions": "netlify-lambda build assets/lambda", "build:preview": "npm run build -D -F", "server": "hugo server", @@ -16,7 +16,7 @@ "copy:deps": "node scripts/copy-deps", "lint": "npm run -s lint:scripts && npm run -s lint:styles", "lint:scripts": "eslint assets/js assets/lambda config", - "lint:styles": "stylelint \"assets/sass/**/*.{css,sass,scss,sss,less}\"", + "lint:styles": "stylelint \"assets/scss/**/*.{css,sass,scss,sss,less}\"", "test": "npm run -s lint" }, "devDependencies": { diff --git a/static/android-chrome-192x192.png b/static/android-chrome-192x192.png index 579b5e1d..f7c60b2c 100644 Binary files a/static/android-chrome-192x192.png and b/static/android-chrome-192x192.png differ diff --git a/static/android-chrome-512x512.png b/static/android-chrome-512x512.png index e994d871..31affbb3 100644 Binary files a/static/android-chrome-512x512.png and b/static/android-chrome-512x512.png differ diff --git a/static/apple-touch-icon.png b/static/apple-touch-icon.png index 60562bee..8286cbc5 100644 Binary files a/static/apple-touch-icon.png and b/static/apple-touch-icon.png differ diff --git a/static/favicon-16x16.png b/static/favicon-16x16.png index a9b2d18f..f71248d2 100644 Binary files a/static/favicon-16x16.png and b/static/favicon-16x16.png differ diff --git a/static/favicon-32x32.png b/static/favicon-32x32.png index 8915f17b..4407268b 100644 Binary files a/static/favicon-32x32.png and b/static/favicon-32x32.png differ diff --git a/static/favicon.ico b/static/favicon.ico index 2c9109b6..b7edcecf 100644 Binary files a/static/favicon.ico and b/static/favicon.ico differ diff --git a/static/image-hyas.jpg b/static/image-hyas.jpg deleted file mode 100644 index 5236cb1e..00000000 Binary files a/static/image-hyas.jpg and /dev/null differ diff --git a/static/image-hyas.png b/static/image-hyas.png new file mode 100644 index 00000000..0552b682 Binary files /dev/null and b/static/image-hyas.png differ diff --git a/static/logo-hyas.png b/static/logo-hyas.png index 8154b5b8..31affbb3 100644 Binary files a/static/logo-hyas.png and b/static/logo-hyas.png differ