Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/h-enk/doks.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHenk Verlinde <henk@ventizo.com>2020-11-04 10:26:58 +0300
committerHenk Verlinde <henk@ventizo.com>2020-11-04 10:26:58 +0300
commit97d8e2c0e2568f9f9f653dcc243d06aa25482e70 (patch)
treef4446085f0fd31c73085b2b1902b2af545d98ae5 /README.md
parent90cea786c1aec4cc7004fdf9571ad05a739aa96c (diff)
feat: add flexsearch
Diffstat (limited to 'README.md')
-rw-r--r--README.md62
1 files changed, 4 insertions, 58 deletions
diff --git a/README.md b/README.md
index 92392ac..e10f4d4 100644
--- a/README.md
+++ b/README.md
@@ -1,59 +1,5 @@
-# Doks
-[![GitHub release](https://img.shields.io/github/release/h-enk/doks.svg?style=flat-square)](https://github.com/h-enk/doks/releases)
-[![Build Status](https://img.shields.io/travis/h-enk/doks.svg?style=flat-square)](https://travis-ci.com/github/h-enk/doks)
-[![Netlify](https://img.shields.io/netlify/8a1009d5-88ac-413e-96ef-3f928674a083?style=flat-square)](https://doks.netlify.app/)
+# Hyas website
-Doks is a Hugo starter helping you build modern documentation websites.
-
-## 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)
-
-See a working example at [doks.netlify.app](https://doks.netlify.app/)
-
-## Requirements
-
-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)
-
-## Get started
-
-Create a new Doks project:
-
-```bash
-$ git clone git@github.com:h-enk/doks.git my-doks-site
-```
-
-Install dependencies:
-
-```bash
-# @ my-doks-site/
-$ yarn install
-```
-
-Build development theme with live reloading and injection:
-
-```bash
-# @ my-doks-site/
-$ 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
-
-## Documentation
-- [Hugo](https://gohugo.io/documentation/)
-- [Hyas](https://gethyas.com/)
-- [Doks](https://getdoks.org/)
+[![GitHub release](https://img.shields.io/github/release/h-enk/gethyas.com.svg?style=flat-square)](https://github.com/h-enk/gethyas.com/releases)
+[![Build Status](https://img.shields.io/travis/h-enk/gethyas.com.svg?style=flat-square)](https://travis-ci.com/github/h-enk/gethyas.com)
+[![Netlify](https://img.shields.io/netlify/72c25737-babf-44b6-98a5-eeb6861ac904?style=flat-square)](https://gethyas.com/)