Skip to content

Commit

Permalink
Update for 0.1.1
Browse files Browse the repository at this point in the history
  • Loading branch information
h-enk committed Sep 29, 2020
1 parent aa4f6e8 commit 6a552c1
Show file tree
Hide file tree
Showing 12 changed files with 401 additions and 249 deletions.
4 changes: 2 additions & 2 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sudo: required
language: node_js
node_js:
- "lts/*"
- "13"
- "14"

install:
- wget "https://github.com/gohugoio/hugo/releases/download/v${HUGO_RELEASE}/hugo_extended_${HUGO_RELEASE}_Linux-64bit.deb"
Expand All @@ -20,4 +20,4 @@ script:
env:
global:
- PRODUCTION=true
- HUGO_RELEASE=0.74.3
- HUGO_RELEASE=0.75.1
9 changes: 8 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

## [0.1.1] - 2020-09-29

### Added

- Base documentation

## [0.1.0] - 2020-07-10

### Added

- [Feather](https://github.com/feathericons/feather), Copyright (c) 2013-2017 Cole Bemis, [MIT License](https://github.com/feathericons/feather/blob/master/LICENSE)
- [Hyas](https://github.com/h-enk/hyas), Copyright (c) 2020 Henk Verlinde, [MIT License](https://github.com/h-enk/hyas/blob/master/LICENSE)

[Unreleased]: https://github.com/h-enk/gethyas.com/compare/v0.1.0...HEAD
[Unreleased]: https://github.com/h-enk/gethyas.com/compare/v0.1.1...HEAD
[0.1.1]: https://github.com/h-enk/gethyas.com/releases/tag/v0.1.1
[0.1.0]: https://github.com/h-enk/gethyas.com/releases/tag/v0.1.0
76 changes: 76 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at henk@henkverlinde.com. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2019 Henk Verlinde
Copyright (c) 2020 Henk Verlinde

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
7 changes: 5 additions & 2 deletions config/_default/params.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,22 @@ title = "Hyas"
titleSeparator = "-"
titleAddition = "Modern Hugo Starter"
description = "Hyas is a Hugo starter helping you build modern websites that are secure, fast, and SEO-ready — by default."

images = ["hyas.png"]

twitterSite = "henkverlinde"
twitterCreator = "henkverlinde"
facebookAuthor = "verlinde.henk"
facebookPublisher = "verlinde.henk"
ogLocale = "en_US"

schemaType = "Organization"
schemaLogo = "logo-hyas.png"
schemaTwitter = "https://twitter.com/henkverlinde"
schemaLinkedIn = "https://www.linkedin.com/in/henkverlinde/"
schemaGitHub = "https://github.com/h-enk"
schemaSection = "blog"

siteLinksSearchBox = false

themeColor = "#fff"
Expand All @@ -29,7 +33,6 @@ footer = "An open source project by <a href=\"https://twitter.com/henkverlinde\"
alert = false
alertText = "Deliver web projects 10x faster. <a class=\"alert-link\" href=\"https://www.netlify.com/whitepaper/\" target=\"_blank\" rel=\"noopener\">Get the free enterprise paper →</a>"

hyasVersion = "v1.2.6"
hyasVersion = "v1.2.7"

docsRepo = "https://github.com/h-enk/gethyas.com/"

2 changes: 1 addition & 1 deletion config/postcss.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ module.exports = {
'./layouts/**/*.html',
'./content/**/*.md',
],
whitelist: [
safelist: [
'lazyloaded',
...whitelister([
'./assets/scss/components/_code.scss',
Expand Down
2 changes: 1 addition & 1 deletion content/docs/core-hyas/performance.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Performance"
description: "Get 100 scores on Google Lighthouse by default. Hyas removes unused css, prefetches links, and lazy loads images."
lead: "Get 100 scores on <a href=\"https://googlechrome.github.io/lighthouse/viewer/?gist=e45b7560a228939b8e7362288844249b\" target=\"_blank\" rel=\"noopener\">Google Lighthouse</a> by default. Hyas removes unused css, prefetches links, and lazy loads images."
lead: "Get 100 scores on <a href=\"https://googlechrome.github.io/lighthouse/viewer/?gist=8b7aec005ae7b9e128ad5c4e2f125fea\" target=\"_blank\" rel=\"noopener\">Google Lighthouse</a> by default. Hyas removes unused css, prefetches links, and lazy loads images."
date: 2020-09-17T15:37:44+02:00
lastmod: 2020-09-17T15:37:44+02:00
draft: false
Expand Down
58 changes: 41 additions & 17 deletions content/docs/prologue/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,26 +15,50 @@ toc: true

## Why Hyas?

- Lightweight code base
- 100 scores [Google Lighthouse](https://googlechrome.github.io/lighthouse/viewer/?gist=e45b7560a228939b8e7362288844249b)
- A+ scores [Mozilla Observatory](https://observatory.mozilla.org/analyze/hyas.netlify.app)
- 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
- Fingerprinting and [SRI](https://developer.mozilla.org/en-US/docs/Web/Security/Subresource_Integrity) (production)
- Remove unused CSS (production) with [PurgeCSS](https://github.com/FullHuman/purgecss)

👉 For a working example see [hyas.netlify.app](https://hyas.netlify.app/)
Six reasons why you should use Hyas.

### Security aware

Get A+ scores on [Mozilla Observatory](https://observatory.mozilla.org/analyze/hyas.netlify.app) out of the box. Easily change the default Security Headers to suit your needs.

👉 [Security]({{< ref "security" >}})

### Fast by default

Get 100 scores on [Google Lighthouse](https://googlechrome.github.io/lighthouse/viewer/?gist=8b7aec005ae7b9e128ad5c4e2f125fea) by default. Hyas removes unused css, prefetches links, and lazy loads images.

👉 [Performance]({{< ref "performance" >}})

### SEO-ready

Use sensible defaults for structured data, open graph, and Twitter cards. Or easily change the SEO settings to your liking.

👉 [SEO]({{< ref "seo" >}})

### Development tools

Code with confidence. Check styles, scripts, and markdown for errors and fix automatically or manually.

👉 [Development Tools]({{< ref "development-tools" >}})

### Bootstrap framework

Build robust, flexible, and intuitive websites with Bootstrap. Or use any other front-end framework if you prefer.

👉 [Bootstrap]({{< ref "bootstrap" >}})

### Netlify-ready

Deploy to Netlify with sensible defaults. Easily use Netlify Functions, Netlify Redirects, and Netlify Headers.

👉 [Netlify]({{< ref "netlify" >}})

## Prerequisites

Make sure all dependencies have been installed:

- [Hugo](https://gohugo.io/) >= 0.74.3/extended
- [Node.js](https://nodejs.org/) >= 13.11.0
- [Hugo](https://gohugo.io/) >= 0.75.1/extended
- [Node.js](https://nodejs.org/) >= 14.12.0
- [Yarn](https://yarnpkg.com/) >= 1.22.5 (recommended)

## Get started
Expand Down Expand Up @@ -80,6 +104,6 @@ Get your Hyas site in 1 min.
[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/h-enk/hyas "Deploy to Netlify")
-->

## Credits
## Example site

Hyas is inspired by [Roots](https://roots.io/) and uses [Atlas](https://github.com/indigotree/atlas) as a starting point.
👉 [hyas.netlify.app](https://hyas.netlify.app/)
2 changes: 1 addition & 1 deletion layouts/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ <h2 class="h4">Security aware</h2>
</div>
<div class="col-lg-5">
<h2 class="h4">Fast by default</h2>
<p>Get 100 scores on <a href="https://googlechrome.github.io/lighthouse/viewer/?gist=e45b7560a228939b8e7362288844249b" target="_blank" rel="noopener">Google Lighthouse</a> by default. Hyas removes unused css, prefetches links, and lazy loads images.</p>
<p>Get 100 scores on <a href="https://googlechrome.github.io/lighthouse/viewer/?gist=8b7aec005ae7b9e128ad5c4e2f125fea" target="_blank" rel="noopener">Google Lighthouse</a> by default. Hyas removes unused css, prefetches links, and lazy loads images.</p>
</div>
<div class="col-lg-5">
<h2 class="h4">SEO-ready</h2>
Expand Down
6 changes: 3 additions & 3 deletions netlify.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
functions = "functions"

[build.environment]
HUGO_VERSION = "0.74.3"
NODE_VERSION = "13.11.0"
NPM_VERSION = "6.13.7"
HUGO_VERSION = "0.75.1"
NODE_VERSION = "14.12.0"
NPM_VERSION = "6.14.8"
YARN_VERSION = "1.22.5"

[context.production]
Expand Down
31 changes: 16 additions & 15 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "doks",
"version": "0.1.0",
"name": "gethyas.com",
"version": "0.1.1",
"private": true,
"browserslist": [
"defaults"
Expand All @@ -19,25 +19,26 @@
"test": "npm run -s lint"
},
"devDependencies": {
"@babel/cli": "^7.10.4",
"@babel/core": "^7.10.4",
"@babel/preset-env": "^7.10.4",
"@fullhuman/postcss-purgecss": "^1.3",
"autoprefixer": "^9.8",
"eslint": "^7.2",
"markdownlint-cli": "^0.23.2",
"netlify-lambda": "^1.6",
"postcss-cli": "^7.1",
"@babel/cli": "^7.11",
"@babel/core": "^7.11",
"@babel/preset-env": "^7.11",
"@fullhuman/postcss-purgecss": "^3.0",
"autoprefixer": "^10.0",
"eslint": "^7.10",
"markdownlint-cli": "^0.23",
"netlify-lambda": "^2.0",
"postcss": "^8.1.1",
"postcss-cli": "^8.0",
"purgecss-whitelister": "^2.4",
"rimraf": "^3.0",
"stylelint": "^13.6",
"stylelint": "^13.7",
"stylelint-config-standard": "^20.0"
},
"dependencies": {
"bootstrap": "^4.5",
"clipboard": "^2.0.6",
"docsearch.js": "^2.6.3",
"instant.page": "^5.1.0",
"clipboard": "^2.0",
"docsearch.js": "^2.6",
"instant.page": "^5.1",
"lazysizes": "^5.2"
}
}
Loading

0 comments on commit 6a552c1

Please sign in to comment.