From 1dc6d0f3650f90be434ec9523839f5953c7bc078 Mon Sep 17 00:00:00 2001 From: Henk Verlinde Date: Thu, 16 Apr 2020 16:30:17 +0200 Subject: [PATCH] Update README + CHANGELOG --- CHANGELOG.md | 70 ++--------------------------- README.md | 125 +++++++++------------------------------------------ 2 files changed, 25 insertions(+), 170 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index e74e0cf..707285c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,71 +6,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] -## [1.2.1] - 2020-03-31 +## [0.1.0] - 2020-04-16 ### Added -- version to package.json - [issue 23](https://github.com/h-enk/hyas/issues/23) -- `copy:deps` to build command - [issue 22](https://github.com/h-enk/hyas/issues/22) -- `clean:deps` command +- [Hyas](https://github.com/h-enk/hyas), Copyright (c) 2019 Henk Verlinde, [MIT License](https://github.com/h-enk/hyas/blob/master/LICENSE) -## [1.2.0] - 2020-03-30 -### Added -- ga-lite - [issue 15](https://github.com/h-enk/hyas/issues/15) -- copy script for dep resources - [issue 14](https://github.com/h-enk/hyas/issues/14) -- flag `--minify` to `build` command - -### Changed -- Bumped `[build.environment]` `netlify.toml` -- Bumped dependencies `package.json` -- Update security headers - [issue 17](https://github.com/h-enk/hyas/issues/17) -- `README.md` -- `robots` tag logic in `seo.html` - -### Removed -- favicon - [issue 12](https://github.com/h-enk/hyas/issues/12) - -## [1.1.0] - 2020-02-06 -### Added -- `` - [issue 12](https://github.com/h-enk/hyas/issues/12) -- breadcrumbList structured data - [issue 11](https://github.com/h-enk/hyas/issues/11) -- body classes - [issue 10](https://github.com/h-enk/hyas/issues/10) -- `.stylelintignore` - [issue 9](https://github.com/h-enk/hyas/issues/9) -- `.eslintignore` - [issue 8](https://github.com/h-enk/hyas/issues/8) - -### Changed -- default theme - [issue 7](https://github.com/h-enk/hyas/issues/7) -- bumped dependency `lazysizes` to `^5.2` -- bumped dependency `HUGO_VERSION` to `0.63.2` - -## [1.0.1] - 2019-12-20 -### Added -- custom `layouts/rss.xml` with page option `feed_exclude: true` - [issue 5](https://github.com/h-enk/hyas/issues/5) -- content `'./content/**/*.md',` to `postcss.config.js` - [issue 2](https://github.com/h-enk/hyas/issues/2) - -### Changed -- set `canonifyURLs = false` in `/config/production/config.toml` and `/config/staging/config.toml` - [issue 3](https://github.com/h-enk/hyas/issues/3) - -### Removed -- `--minify` in `build` command `package.json` - [issue 4](https://github.com/h-enk/hyas/issues/4) - -## [1.0.0] - 2019-12-11 -### Added -- [Layouts](https://github.com/h-enk/hyas/tree/master/layouts) -- [Image](https://github.com/h-enk/hyas/blob/master/layouts/shortcodes/img.html) shortcode -- [Directories](https://github.com/h-enk/hyas#theme-structure) -- [Scripts](https://github.com/h-enk/hyas/blob/master/package.json) -- bootstrap 4.4.1 -- @fullhuman/postcss-purgecss 1.3.0 -- purgecss-whitelister 2.4.0 -- eslint 6.7.2 -- stylelint 12.0.0 -- stylelint-config-standard 19.0.0 -- rimraf 3.0.0 -- lazysizes 5.2.0-beta1 -- [Atlas](https://github.com/indigotree/atlas), Copyright (c) 2017 Indigo Tree, [MIT License](https://github.com/indigotree/atlas/blob/master/LICENSE) - -[Unreleased]: https://github.com/h-enk/hyas/compare/v1.2.1...HEAD -[1.2.1]: https://github.com/h-enk/hyas/releases/tag/v1.2.1 -[1.2.0]: https://github.com/h-enk/hyas/releases/tag/v1.2.0 -[1.1.0]: https://github.com/h-enk/hyas/releases/tag/v1.1.0 -[1.0.1]: https://github.com/h-enk/hyas/releases/tag/v1.0.1 -[1.0.0]: https://github.com/h-enk/hyas/releases/tag/v1.0.0 +[Unreleased]: https://github.com/h-enk/hyas/compare/v0.1.0...HEAD +[0.1.0]: https://github.com/h-enk/hyas/releases/tag/v0.1.0 diff --git a/README.md b/README.md index 537693d..128798d 100644 --- a/README.md +++ b/README.md @@ -1,47 +1,47 @@ -# Hyas -[![GitHub release](https://img.shields.io/github/release/h-enk/hyas.svg?style=flat-square)](https://github.com/h-enk/hyas/releases) -[![Build Status](https://img.shields.io/travis/h-enk/hyas.svg?style=flat-square)](https://travis-ci.org/h-enk/hyas) -[![Netlify](https://img.shields.io/netlify/895a161c-86be-48a2-8c57-a8c5d68cd1a4?style=flat-square)](https://hyas.netlify.com/) +# 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.org/github/h-enk/doks) +[![Netlify](https://img.shields.io/netlify/33fb6ec8-d314-4695-bbb6-2b3c1b665cbf?style=flat-square)](https://doks.netlify.app/) -Hugo boilerplate helping you build fast, robust, and adaptable websites. +Hugo starter helping you build kick-ass documentation websites. -## Features - -- 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) +## What you get +- Lightweight code base +- 100/A+ scores Google Lighthouse and [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) ## Requirements Make sure all dependencies have been installed: -- Hugo >= 0.68.3/extended +- Hugo >= 0.69.0/extended - Node.js >= 13.11.0 - npm >= 6.13.7 -- Yarn >= 1.22.0 (recommended) +- Yarn >= 1.22.4 (recommended) ## Getting started -Create a new Hyas project: +Create a new Doks project: ```bash -$ git clone git@github.com:h-enk/hyas.git my-hyas-site +$ git clone git@github.com:h-enk/doks.git my-doks-site ``` Install dependencies: ```bash -# @ my-hyas-site/ +# @ my-doks-site/ $ yarn install ``` Build development theme with live reloading and injection: ```bash -# @ my-hyas-site/ +# @ my-doks-site/ $ yarn start ``` @@ -51,89 +51,6 @@ $ yarn start - `yarn clean` - Delete temporary directories - `yarn build` - Build production theme -## Theme structure - -```shell -my-hyas-site/ # → Root of your Hyas based theme -├── archetypes/ # → Content template files -├── assets/ # → Asset files (fonts, images, js, lambda, and sass) -├── config/ # → Configuration directives -│ ├── _default/ # → Development and defaults -│ ├── production/ # → Production specific -│ ├── staging/ # → Staging specific -│ ├── postcss.config.js # → PostCSS configuration file -├── content/ # → Content using page bundles -├── data/ # → Custom data files -├── functions/ # → Netlify lambda functions directory (production) -├── layouts/ # → Template files -│ ├── _default/ # → Base templates for list & singular pages -│ ├── partials/ # → Partials (footer, head, header, and sidebar) -│ ├── shortcodes/ # → Shortcodes (img) -│ │── 404.html # → 404 Template -│ │── index.headers # → Custom Netlify HTTP headers -│ │── index.html # → Homepage template -│ │── index.redirects # → Custom Netlify redirect rules -│ │── robots.txt # → Template for robots.txt -│ │── sitemap.xml # → Custom sitemap template -├── node_modules/ # → Node.js packages (never edit) -├── public/ # → Publish directory (temporary) -├── resources/ # → Resource cache directory (temporary) -├── static/ # → Static content (favicons et cetera) -├── .eslintrc.json # → ESLint configuration -├── .stylelintrc.json # → stylelint configuration -├── netlify.toml # → Netlify configuration -├── package.json # → Node.js dependencies and scripts -└── yarn.lock # → Yarn lock file (never edit) -``` - -## Theme setup -Edit files in `config/` directory. - - -## Theme development -### Sass - -Don't like Bootstrap? Remove it: -```bash -# @ my-hyas-site/ -$ yarn remove bootstrap -``` -Also make sure to update your sass files, like `app.scss`. - -### Images - -Use the image shortcode: -``` -{{< img src="image-in-page-bundle.jpg" alt="Text description image" caption="Caption, optional" class="wide" >}} -``` - -Configuration in `config/_default/params.toml`: - -```toml -quality = 85 -bgColor = "#fff" -landscapePhotoWidths = [900, 700, 500] -portraitPhotoWidths = [1500, 1000, 750] -lqipWidth = "20x" -``` - -### Sitemap -Exclude a page by adding the following front matter variable: -```yaml -sitemap_exclude: true -``` - -### Robots -Add a custom [robots meta tag](https://developers.google.com/search/reference/robots_meta_tag) by adding the following front matter variable: -```yaml -robots: "noindex, noarchive" -``` -This will output: - -```html - -``` - ## Documentation -- [Hugo](https://gohugo.io/documentation/) -- [Goldmark](https://github.com/yuin/goldmark/) +- [Hyas](https://gethyas.com/) +- [Doks](https://doks.netlify.app/)