-
-
Notifications
You must be signed in to change notification settings - Fork 359
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
79 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,80 @@ | ||
# Hyas website | ||
# Doks | ||
|
||
[![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/) | ||
[![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/h-enk/doks) | ||
[![Netlify](https://img.shields.io/netlify/895a161c-86be-48a2-8c57-a8c5d68cd1a4?style=flat-square)](https://doks.netlify.com/) | ||
|
||
Doks is a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default. | ||
|
||
## Why Doks? | ||
|
||
Six reasons why you should use Doks: | ||
|
||
1. __Security aware__. Get A+ scores on [Mozilla Observatory](https://observatory.mozilla.org/analyze/doks.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. Doks 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. | ||
|
||
## Requirements | ||
|
||
Make sure all dependencies have been installed: | ||
|
||
- [Hugo](https://gohugo.io/) >= 0.75.0/extended | ||
- [Node.js](https://nodejs.org/) >= 14.15.0 (needed to install npm packages and run scripts | ||
|
||
## Get started | ||
|
||
Create a new Doks project: | ||
|
||
```bash | ||
git clone https://github.com/h-enk/doks.git my-doks-site | ||
``` | ||
|
||
Install dependencies: | ||
|
||
```bash | ||
# @ my-doks-site/ | ||
$ npm run install | ||
``` | ||
|
||
Build development theme with live reloading and injection: | ||
|
||
```bash | ||
# @ my-doks-site/ | ||
$ npm run start | ||
``` | ||
|
||
### Other commands | ||
|
||
- `npm run lint:styles` - Check Sass for errors | ||
- `npm run lint:scripts` - Check JavaScript for errors | ||
- `npm run clean` - Delete temporary directories | ||
- `npm run build` - Build production theme | ||
|
||
## Quick start | ||
|
||
Get your Doks 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/doks) | ||
|
||
## Example site | ||
|
||
👉 [doks.netlify.app](https://doks.netlify.app/) | ||
|
||
## Documentation | ||
|
||
- [Netlify](https://docs.netlify.com/) | ||
- [Hugo](https://gohugo.io/documentation/) | ||
- [Doks](https://getdoks.org/) | ||
|
||
## Communities | ||
|
||
- [Netlify Community](https://community.netlify.com/) | ||
- [Hugo Forums](https://discourse.gohugo.io/) |