Initial commit
This commit is contained in:
23
content/_index.md
Normal file
23
content/_index.md
Normal file
@ -0,0 +1,23 @@
|
||||
---
|
||||
title : "Doks"
|
||||
description: "Hugo boilerplate helping you build fast, flexible, and search ready websites."
|
||||
date: 2019-12-02T13:47:16+01:00
|
||||
draft: false
|
||||
images: ["image-hyas.jpg"]
|
||||
lead: "Hugo documentation theme build on Hyas."
|
||||
---
|
||||
|
||||
<div class="row justify-content-center">
|
||||
<div class="col-lg-5">
|
||||
<h2 class="h4 mt-1">100/A+ scores</h5>
|
||||
<p>Get perfect Google Lighthouse and <a href="https://observatory.mozilla.org/" target="_blank" rel="noreferrer noopener">Mozilla Observatory</a> scores by default.</p>
|
||||
</div>
|
||||
<div class="col-lg-5">
|
||||
<h2 class="h4 mt-1">Algolia DocSearch</h5>
|
||||
<p>The best search experience for docs, by <a href="https://docsearch.algolia.com/" target="_blank" rel="noreferrer noopener">Algolia</a>, for free.</p>
|
||||
</div>
|
||||
<div class="col-lg-5">
|
||||
<h2 class="h4 mt-1">Dark/Light toggle</h5>
|
||||
<p>Enable dark mode at night or in dark environments.</p>
|
||||
</div>
|
||||
</div>
|
9
content/authors/_index.md
Normal file
9
content/authors/_index.md
Normal file
@ -0,0 +1,9 @@
|
||||
---
|
||||
title: "Authors"
|
||||
description: ""
|
||||
date: 2020-03-23T11:01:55+01:00
|
||||
draft: false
|
||||
images: [""]
|
||||
---
|
||||
|
||||
The Doks Blog authors
|
11
content/authors/henk-verlinde/_index.md
Normal file
11
content/authors/henk-verlinde/_index.md
Normal file
@ -0,0 +1,11 @@
|
||||
---
|
||||
title: "Henk Verlinde"
|
||||
description: ""
|
||||
date: 2020-03-23T11:01:55+01:00
|
||||
draft: false
|
||||
images: [""]
|
||||
---
|
||||
|
||||
Creator of Doks.
|
||||
|
||||
[@HenkVerlinde](https://twitter.com/henkverlinde)
|
7
content/blog/_index.md
Normal file
7
content/blog/_index.md
Normal file
@ -0,0 +1,7 @@
|
||||
---
|
||||
title: "Blog"
|
||||
description: ""
|
||||
date: 2019-12-02T13:47:16+01:00
|
||||
draft: false
|
||||
images: [""]
|
||||
---
|
9
content/blog/say-hello-to-doks/index.md
Normal file
9
content/blog/say-hello-to-doks/index.md
Normal file
@ -0,0 +1,9 @@
|
||||
---
|
||||
title: "Say hello to Doks 👋"
|
||||
description: ""
|
||||
lead: "Doks is a Hugo documentation theme build on Hyas."
|
||||
date: 2020-03-14T10:12:13+02:00
|
||||
draft: false
|
||||
images: [""]
|
||||
authors: ["Henk Verlinde"]
|
||||
---
|
8
content/docs/_index.md
Normal file
8
content/docs/_index.md
Normal file
@ -0,0 +1,8 @@
|
||||
---
|
||||
title : "Docs"
|
||||
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"]
|
||||
---
|
8
content/docs/basic-hyas/_index.md
Normal file
8
content/docs/basic-hyas/_index.md
Normal file
@ -0,0 +1,8 @@
|
||||
---
|
||||
title : "Basic Hyas"
|
||||
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"]
|
||||
---
|
55
content/docs/basic-hyas/directory-structure.md
Normal file
55
content/docs/basic-hyas/directory-structure.md
Normal file
@ -0,0 +1,55 @@
|
||||
---
|
||||
title: "Directory Structure"
|
||||
description: "The Hyas directory structure explained."
|
||||
lead: "The Hyas directory structure follows and extends the Hugo directory structure. So you can easily locate stuff."
|
||||
date: 2020-01-07T16:02:42+01:00
|
||||
draft: false
|
||||
images: ["image-hyas.jpg"]
|
||||
menu:
|
||||
docs:
|
||||
parent: "basic-hyas"
|
||||
weight: 110
|
||||
toc: true
|
||||
---
|
||||
|
||||
A basic Hyas project would be structured like this:
|
||||
|
||||
```shell
|
||||
my-hyas-site/
|
||||
├── archetypes/
|
||||
├── assets/
|
||||
├── config/
|
||||
│ ├── _default/
|
||||
│ ├── production/
|
||||
│ ├── staging/
|
||||
│ ├── postcss.config.js
|
||||
├── content/
|
||||
├── data/
|
||||
├── functions/
|
||||
├── layouts/
|
||||
│ ├── _default/
|
||||
│ ├── partials/
|
||||
│ ├── shortcodes/
|
||||
│ │── 404.html
|
||||
│ │── index.headers
|
||||
│ │── index.html
|
||||
│ │── index.redirects
|
||||
│ │── robots.txt
|
||||
│ │── sitemap.xml
|
||||
├── node_modules/
|
||||
├── public/
|
||||
├── resources/
|
||||
├── static/
|
||||
├── .eslintrc.json
|
||||
├── .stylelintrc.json
|
||||
├── netlify.toml
|
||||
├── package.json
|
||||
└── yarn.lock
|
||||
```
|
||||
|
||||
## The root directory
|
||||
Lorem ipsum dolor sit amet, consectetur __adipiscing__ elit. Donec rhoncus commodo nisl, et volutpat sem maximus quis. Phasellus in consequat eros. Etiam in dui eu urna pharetra placerat in efficitur mi. Proin at dui non quam mollis consequat non vel mauris.
|
||||
|
||||
Phasellus sagittis nibh et nibh dictum lobortis. Proin nec ultrices tortor. Aliquam erat volutpat. Donec elementum erat non urna commodo hendrerit. Vestibulum est felis, pellentesque sit amet nulla tristique, porttitor commodo libero.
|
||||
|
||||
Vestibulum iaculis velit ut turpis sodales, nec ullamcorper ex imperdiet. Nullam in facilisis sapien. Donec pretium sagittis tortor, id pretium sapien dignissim vitae. Donec finibus, tellus vel vestibulum malesuada, felis augue ultrices elit, et ornare velit lacus ut tortor.
|
13
content/docs/basic-hyas/layouts.md
Normal file
13
content/docs/basic-hyas/layouts.md
Normal file
@ -0,0 +1,13 @@
|
||||
---
|
||||
title: "Layouts"
|
||||
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-08T11:30:27+01:00
|
||||
draft: false
|
||||
images: ["image-hyas.jpg"]
|
||||
menu:
|
||||
docs:
|
||||
parent: "basic-hyas"
|
||||
weight: 130
|
||||
toc: false
|
||||
---
|
13
content/docs/basic-hyas/project-configuration.md
Normal file
13
content/docs/basic-hyas/project-configuration.md
Normal file
@ -0,0 +1,13 @@
|
||||
---
|
||||
title: "Project Configuration"
|
||||
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:20:26+01:00
|
||||
draft: false
|
||||
images: ["image-hyas.jpg"]
|
||||
menu:
|
||||
docs:
|
||||
parent: "basic-hyas"
|
||||
weight: 120
|
||||
toc: true
|
||||
---
|
8
content/docs/prologue/_index.md
Normal file
8
content/docs/prologue/_index.md
Normal file
@ -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"]
|
||||
---
|
67
content/docs/prologue/introduction.md
Normal file
67
content/docs/prologue/introduction.md
Normal file
@ -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).
|
8
content/docs/styles-and-assets/_index.md
Normal file
8
content/docs/styles-and-assets/_index.md
Normal file
@ -0,0 +1,8 @@
|
||||
---
|
||||
title: "Styles and Assets"
|
||||
description: "Hugo boilerplate helping you build fast, robust, and flexible websites."
|
||||
lead: "Hugo boilerplate helping you build fast, robust, and flexible websites."
|
||||
date: 2020-04-02T17:00:04+02:00
|
||||
draft: false
|
||||
images: ["image-hyas.jpg"]
|
||||
---
|
14
content/docs/styles-and-assets/use-css-in-hyas.md
Normal file
14
content/docs/styles-and-assets/use-css-in-hyas.md
Normal file
@ -0,0 +1,14 @@
|
||||
---
|
||||
title: "Use CSS in Hyas"
|
||||
description: "Hugo boilerplate helping you build fast, robust, and flexible websites."
|
||||
lead: "Hugo boilerplate helping you build fast, robust, and flexible websites."
|
||||
date: 2020-04-02T17:02:38+02:00
|
||||
draft: false
|
||||
images: ["image-hyas.jpg"]
|
||||
menu:
|
||||
docs:
|
||||
parent: "styles-and-assets"
|
||||
weight: 210
|
||||
toc: false
|
||||
---
|
||||
Global stylesheets and assets are usually located in the `src/assets` folder and imported into `src/main.js`.
|
Reference in New Issue
Block a user