feat: add flexsearch

This commit is contained in:
Henk Verlinde
2020-11-04 08:26:58 +01:00
parent 90cea786c1
commit 97d8e2c0e2
130 changed files with 4162 additions and 1763 deletions

View File

@ -1,8 +1,9 @@
---
title : "Prologue"
description: "Prologue Doks."
description: "Prologue Hyas."
lead: ""
date: 2020-04-17T08:48:45+00:00
date: 2020-10-06T08:48:45+00:00
lastmod: 2020-10-06T08:48:45+00:00
draft: false
images: [image-doks.png]
images: []
---

View File

@ -0,0 +1,92 @@
---
title: "Commands"
description: "Repository commands."
lead: "Repository commands."
date: 2020-10-13T15:21:01+02:00
lastmod: 2020-10-13T15:21:01+02:00
draft: false
images: []
menu:
docs:
parent: "prologue"
weight: 030
toc: true
---
## start
Start local development server:
```bash
yarn start
```
## build
Build production website:
```bash
yarn build
```
### :functions
```bash
yarn build:functions
```
### :preview
```bash
yarn build:preview
```
## server
Start local development server:
```bash
yarn server
```
## clean
Delete temporary directories:
```bash
yarn clean
```
## lint
Check scripts, styles, and markdown for errors:
```bash
yarn lint
```
### :scripts
```bash
yarn lint:scripts [--fix]
```
### :styles
```bash
yarn lint:styles [--fix]
```
### :markdown
```bash
yarn lint:markdown [--fix]
```
## test
Check scripts, styles, and markdown for errors:
```bash
yarn test
```

View File

@ -0,0 +1,103 @@
---
title: "Hyas CLI"
description: "Hyas command line tool."
lead: "Hyas command line tool."
date: 2020-09-22T08:38:48+02:00
lastmod: 2020-09-22T08:38:48+02:00
draft: false
images: []
menu:
docs:
parent: "prologue"
weight: 020
toc: true
---
```bash
Usage: hyas <command> [options]
Commands:
build Build production website
clean Delete temporary directories
create [dir] Create a new Hyas project
start Start local development server
Options:
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
Run hyas <command> --help for detailed usage of given command.
```
## Installation
Install the [Hyas CLI](https://www.npmjs.com/package/@hyas/cli) globally:
```bash
yarn add global @hyas/cli
```
```bash
npm install -g @hyas/cli
```
## npx
Or use [npx](https://nodejs.dev/learn/the-npx-nodejs-package-runner):
```bash
npx @hyas/cli <command> [options]
```
## Commands
### Create
Create a new Hyas project:
```bash
hyas create [dir]
```
### Start
Start local development server:
```bash
hyas start
```
### Build
Build production website:
```bash
hyas build
```
### Clean
Delete temporary directories:
```bash
hyas clean
```
## Options
### -h, --help
Show help.
### -v, --version
Show version number.
## Update
You'll get notified when an update is available:
```bash
Update available: 0.3.2
Run npm install -g @hyas/cli to update
```

View File

@ -1,10 +1,11 @@
---
title: "Introduction"
description: "Introduction Doks."
lead: "Doks is a Hugo starter helping you build modern documentation websites."
date: 2020-04-17T08:48:57+00:00
description: "Introduction Hyas."
lead: "Hyas is a Hugo starter helping you build modern websites that are secure, fast, and SEO-ready — by default."
date: 2020-10-06T08:48:57+00:00
lastmod: 2020-10-06T08:48:57+00:00
draft: false
images: [image-doks.png]
images: []
menu:
docs:
parent: "prologue"
@ -12,55 +13,92 @@ weight: 010
toc: true
---
## Features
- Lightweight code base
- 100 scores Google Lighthouse
- A+ scores [Mozilla Observatory](https://observatory.mozilla.org/)
- [Algolia DocSearch](https://docsearch.algolia.com/) support
- Dark/Light toggle
- Blog ready
- Easily make it your own
- All in [Hyas](https://github.com/h-enk/hyas)
## Why Hyas?
See a working example at [doks.netlify.app](https://doks.netlify.app/)
Six reasons why you should use Hyas:
## Requirements
1. __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.
2. __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.
3. __SEO-ready__. Use sensible defaults for structured data, open graph, and Twitter cards. Or easily change the SEO settings to your liking.
4. __Development tools__. Code with confidence. Check styles, scripts, and markdown for errors and fix automatically or manually.
5. __Bootstrap framework__. Build robust, flexible, and intuitive websites with Bootstrap. Or use any other front-end framework if you prefer.
6. __Netlify-ready__. Deploy to Netlify with sensible defaults. Easily use Netlify Functions, Netlify Redirects, and Netlify Headers.
## Prerequisites
Make sure all dependencies have been installed:
- [Hugo](https://gohugo.io/) >= 0.69.0/extended
- [Node.js](https://nodejs.org/) >= 13.11.0
- [Yarn](https://yarnpkg.com/) >= 1.22.4 (recommended)
- [Hugo](https://gohugo.io/) >= 0.75.1/extended
- [Node.js](https://nodejs.org/) >= 14.12.0
- [Yarn](https://yarnpkg.com/) >= 1.22.5 (recommended)
{{< alert icon="💡" text="npm (comes with Node.js) and Yarn are both Node.js package managers. <a href=\"https://classic.yarnpkg.com/en/\">Yarn</a> is faster, more reliable, and more secure than npm." >}}
## Get started
Create a new Doks project:
Three ways to get started.
### Hyas CLI
Install the Hyas CLI globally:
```bash
$ git clone git@github.com:h-enk/doks.git my-doks-site
yarn add global @hyas/cli
```
Create a new Hyas project:
```bash
hyas create [dir]
```
#### npx
Or use [npx](https://nodejs.dev/learn/the-npx-nodejs-package-runner):
```bash
npx @hyas/cli create my-hyas-site
```
See also: [Hyas CLI]({{< ref "hyas-cli" >}}).
### Repository clone
Create a new Hyas project:
```bash
git clone git@github.com:h-enk/hyas.git my-hyas-site
```
Install dependencies:
```bash
# @ my-doks-site/
$ yarn install
yarn install
```
Build development theme with live reloading and injection:
Start local development server:
```bash
# @ my-doks-site/
$ yarn start
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
See also: [commands]({{< ref "commands" >}}).
## Documentation
- [Hugo](https://gohugo.io/documentation/)
- [Hyas](https://gethyas.com/)
- [Doks](https://getdoks.org/)
### Netlify deploy
Get your Hyas site in 1 min.
<a class="btn btn-primary btn-sm px-3" href="https://app.netlify.com/start/deploy?repository=https://github.com/h-enk/hyas" role="button">Deploy to Netlify</a>
<!--
[![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")
-->
## Example site
👉 [hyas.netlify.app](https://hyas.netlify.app/)