diff options
Diffstat (limited to 'content/docs/prologue')
| -rw-r--r-- | content/docs/prologue/_index.md | 8 | ||||
| -rw-r--r-- | content/docs/prologue/introduction.md | 67 |
2 files changed, 75 insertions, 0 deletions
diff --git a/content/docs/prologue/_index.md b/content/docs/prologue/_index.md new file mode 100644 index 0000000..0a71f2b --- /dev/null +++ b/content/docs/prologue/_index.md @@ -0,0 +1,8 @@ +--- +title : "Prologue" +description: "Hugo boilerplate helping you build fast, robust, and flexible websites." +lead: "Hugo boilerplate helping you build fast, robust, and flexible websites." +date: 2019-12-02T13:47:16+01:00 +draft: false +images: ["image-hyas.jpg"] +--- diff --git a/content/docs/prologue/introduction.md b/content/docs/prologue/introduction.md new file mode 100644 index 0000000..5fae1f4 --- /dev/null +++ b/content/docs/prologue/introduction.md @@ -0,0 +1,67 @@ +--- +title: "Introduction" +description: "Hugo boilerplate helping you build fast, robust, and flexible websites." +lead: "Hugo boilerplate helping you build fast, robust, and flexible websites." +date: 2020-01-07T16:23:23+01:00 +draft: false +images: ["image-hyas.jpg"] +menu: + docs: + parent: "prologue" +weight: 010 +toc: true +--- + +<div class="card bg-light border-0"> + <div class="card-body"> + 👉 This is some text within a card body. + </div> +</div> + +## Why Hyas? +- Bootstrap Sass (no JavaScript) and Autoprefixer +- Check Sass and JavaScript for errors +- 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) + +## Prerequisites +Make sure all dependencies have been installed: + +- Hugo >= 0.62.2/extended +- Node.js >= 10.16.0 +- npm >= 6.9.0 +- Yarn >= 1.21.1 (recommended) + +## Internal links + +[Check out the directory structure]({{< ref "docs/basic-hyas/directory-structure.md" >}}). + +## How to install +Create a new Hyas project: + +```bash +git clone git@github.com:h-enk/hyas.git my-hyas-site +``` + +Install dependencies: + +```bash +yarn install +``` + +Build development theme with live reloading and injection: + +```bash +yarn start +``` + +### Other commands +- `yarn lint:styles` - Check Sass for errors +- `yarn lint:scripts` - Check JavaScript for errors +- `yarn clean` - Delete temporary directories +- `yarn build` - Build production theme + +## Alternatives +- [Atlas](https://github.com/indigotree/atlas).
\ No newline at end of file |