diff --git a/README.md b/README.md index cc10700..5ea4a97 100644 --- a/README.md +++ b/README.md @@ -3,25 +3,27 @@ [![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 starter helping you build kick-ass documentation websites. +Doks is a Hugo starter helping you build modern documentation websites. -## What you get +## Features - Lightweight code base -- 100/A+ scores Google Lighthouse and [Mozilla Observatory](https://observatory.mozilla.org/) +- 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 >= 0.69.0/extended -- Node.js >= 13.11.0 -- npm >= 6.13.7 -- Yarn >= 1.22.4 (recommended) +- [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 @@ -52,5 +54,6 @@ $ yarn start - `yarn build` - Build production theme ## Documentation +- [Hugo](https://gohugo.io/documentation/) - [Hyas](https://gethyas.com/) -- [Doks](https://doks.netlify.app/) +- [Doks](https://getdoks.org/) diff --git a/config/_default/menus.toml b/config/_default/menus.toml index 55a5505..5e1813d 100644 --- a/config/_default/menus.toml +++ b/config/_default/menus.toml @@ -5,16 +5,10 @@ url = "/docs/prologue/" [[docs]] - name = "Basic Hyas" + name = "Help" weight = 20 - identifier = "basic-hyas" - url = "/docs/basic-hyas/" - -[[docs]] - name = "Styles and assets" - weight = 30 - identifier = "styles-and-assets" - url = "/docs/styles-and-assets/" + identifier = "help" + url = "/docs/help/" [[main]] name = "Docs" @@ -29,7 +23,7 @@ [[social]] name = "Twitter" pre = "" - url = "https://twitter.com/henkverlinde" + url = "https://twitter.com/getdoks" weight = 10 [[social]] diff --git a/config/_default/params.toml b/config/_default/params.toml index 2f1c0a6..491a6ee 100644 --- a/config/_default/params.toml +++ b/config/_default/params.toml @@ -1,14 +1,14 @@ title = "Doks" titleSeparator = "-" -titleAddition = "Hugo Documentation Starter" -description = "Hugo starter helping you build kick-ass documentation websites." +titleAddition = "Modern Hugo Documentation Starter" +description = "Hugo starter helping you build modern documentation websites." images = ["image-doks.png"] twitterSite = "@henkverlinde" twitterCreator = "@henkverlinde" ogLocale = "en_US" schemaType = "Organization" schemaLogo = "logo-doks.png" -schemaTwitter = "https://twitter.com/henkverlinde" +schemaTwitter = "https://twitter.com/getdoks" schemaLinkedIn = "https://www.linkedin.com/in/henkverlinde/" schemaSection = "news" siteLinksSearchBox = false diff --git a/content/_index.md b/content/_index.md index f46046f..ce8c3a9 100644 --- a/content/_index.md +++ b/content/_index.md @@ -1,10 +1,10 @@ --- title : "Doks" -description: "Hugo starter helping you build kick-ass documentation websites." -date: 2019-12-02T13:47:16+01:00 +description: "Hugo starter helping you build modern documentation websites." +date: 2020-04-17T08:47:36+00:00 draft: false images: [image-doks.png] -lead: "Hugo starter helping you build kick-ass documentation websites." +lead: "Hugo starter helping you build modern documentation websites." ---
diff --git a/content/authors/_index.md b/content/authors/_index.md index b004005..976ef7b 100644 --- a/content/authors/_index.md +++ b/content/authors/_index.md @@ -1,7 +1,7 @@ --- title: "Authors" -description: "" -date: 2020-03-23T11:01:55+01:00 +description: "The Doks Blog authors." +date: 2020-04-17T08:50:29+00:00 draft: false images: [image-doks.png] --- diff --git a/content/authors/henk-verlinde/_index.md b/content/authors/henk-verlinde/_index.md index 5cdbb0f..17eb2a0 100644 --- a/content/authors/henk-verlinde/_index.md +++ b/content/authors/henk-verlinde/_index.md @@ -1,7 +1,7 @@ --- title: "Henk Verlinde" -description: "" -date: 2020-03-23T11:01:55+01:00 +description: "Creator of Doks." +date: 2020-04-17T08:50:45+00:00 draft: false images: [image-doks.png] --- diff --git a/content/blog/_index.md b/content/blog/_index.md index 7a83287..89cee49 100644 --- a/content/blog/_index.md +++ b/content/blog/_index.md @@ -1,7 +1,7 @@ --- title: "Blog" -description: "" -date: 2019-12-02T13:47:16+01:00 +description: "The Doks Blog." +date: 2020-04-17T08:49:55+00:00 draft: false images: [image-doks.png] --- diff --git a/content/blog/say-hello-to-doks/index.md b/content/blog/say-hello-to-doks/index.md index d42a157..90057de 100644 --- a/content/blog/say-hello-to-doks/index.md +++ b/content/blog/say-hello-to-doks/index.md @@ -1,8 +1,8 @@ --- title: "Say hello to Doks 👋" -description: "Doks is a Hugo starter helping you build kick-ass documentation websites." -lead: "Doks is a Hugo starter helping you build kick-ass documentation websites." -date: 2020-03-14T10:12:13+02:00 +description: "Doks is a Hugo starter helping you build modern documentation websites." +lead: "Doks is a Hugo starter helping you build modern documentation websites." +date: 2020-04-17T08:50:12+00:00 draft: false images: [image-doks.png] authors: ["Henk Verlinde"] diff --git a/content/docs/_index.md b/content/docs/_index.md index 4e4babd..9921c4b 100644 --- a/content/docs/_index.md +++ b/content/docs/_index.md @@ -1,8 +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 +description: "Docs Doks." +lead: "" +date: 2020-04-17T08:48:23+00:00 draft: false images: [image-doks.png] --- diff --git a/content/docs/basic-hyas/_index.md b/content/docs/basic-hyas/_index.md deleted file mode 100644 index b1184c4..0000000 --- a/content/docs/basic-hyas/_index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -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-doks.png] ---- diff --git a/content/docs/basic-hyas/directory-structure.md b/content/docs/basic-hyas/directory-structure.md deleted file mode 100644 index be043cd..0000000 --- a/content/docs/basic-hyas/directory-structure.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -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-doks.png] -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. diff --git a/content/docs/basic-hyas/layouts.md b/content/docs/basic-hyas/layouts.md deleted file mode 100644 index f4ef3c4..0000000 --- a/content/docs/basic-hyas/layouts.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -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-doks.png] -menu: - docs: - parent: "basic-hyas" -weight: 130 -toc: false ---- diff --git a/content/docs/basic-hyas/project-configuration.md b/content/docs/basic-hyas/project-configuration.md deleted file mode 100644 index a45a844..0000000 --- a/content/docs/basic-hyas/project-configuration.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -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-doks.png] -menu: - docs: - parent: "basic-hyas" -weight: 120 -toc: true ---- diff --git a/content/docs/help/_index.md b/content/docs/help/_index.md new file mode 100644 index 0000000..786f8dc --- /dev/null +++ b/content/docs/help/_index.md @@ -0,0 +1,8 @@ +--- +title: "Help" +description: "Help Doks." +lead: "" +date: 2020-04-17T08:49:15+00:00 +draft: false +images: [image-doks.png] +--- diff --git a/content/docs/help/faq.md b/content/docs/help/faq.md new file mode 100644 index 0000000..4b29870 --- /dev/null +++ b/content/docs/help/faq.md @@ -0,0 +1,22 @@ +--- +title: "FAQ" +description: "FAQ Doks." +lead: "" +date: 2020-04-17T08:49:31+00:00 +draft: false +images: [image-doks.png] +menu: + docs: + parent: "help" +weight: 110 +toc: true +--- + +## Where to start from here? +Please make sure to check out the documentation: +- [Hugo](https://gohugo.io/documentation/) +- [Hyas](https://gethyas.com/) +- [Doks](https://getdoks.org/) + +## Can I get support? +Visit [Hugo Discourse](https://discourse.gohugo.io/) and use the search. It that does not help, start a new topic and ask your questions. diff --git a/content/docs/prologue/_index.md b/content/docs/prologue/_index.md index c3e5c38..262b83e 100644 --- a/content/docs/prologue/_index.md +++ b/content/docs/prologue/_index.md @@ -1,8 +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 +description: "Prologue Doks." +lead: "" +date: 2020-04-17T08:48:45+00:00 draft: false images: [image-doks.png] --- diff --git a/content/docs/prologue/introduction.md b/content/docs/prologue/introduction.md index 3093573..b4fc188 100644 --- a/content/docs/prologue/introduction.md +++ b/content/docs/prologue/introduction.md @@ -1,8 +1,8 @@ --- 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 +description: "Introduction Doks." +lead: "Doks is a Hugo starter helping you build modern documentation websites." +date: 2020-04-17T08:48:57+00:00 draft: false images: [image-doks.png] menu: @@ -12,49 +12,46 @@ weight: 010 toc: true --- -
-
- 👉 This is some text within a card body. -
-
+## 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? -- 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) +See a working example at [doks.netlify.app](https://doks.netlify.app/) + +## Requirements -## 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) +- [Hugo](https://gohugo.io/) >= 0.69.0/extended +- [Node.js](https://nodejs.org/) >= 13.11.0 +- [Yarn](https://yarnpkg.com/) >= 1.22.4 (recommended) -## Internal links +## Get started -[Check out the directory structure]({{< ref "docs/basic-hyas/directory-structure.md" >}}). - -## How to install -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 -yarn install +# @ my-doks-site/ +$ yarn install ``` Build development theme with live reloading and injection: ```bash -yarn start +# @ my-doks-site/ +$ yarn start ``` ### Other commands @@ -63,5 +60,7 @@ yarn start - `yarn clean` - Delete temporary directories - `yarn build` - Build production theme -## Alternatives -- [Atlas](https://github.com/indigotree/atlas). \ No newline at end of file +## Documentation +- [Hugo](https://gohugo.io/documentation/) +- [Hyas](https://gethyas.com/) +- [Doks](https://getdoks.org/) diff --git a/content/docs/styles-and-assets/_index.md b/content/docs/styles-and-assets/_index.md deleted file mode 100644 index b45fa47..0000000 --- a/content/docs/styles-and-assets/_index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -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-doks.png] ---- diff --git a/content/docs/styles-and-assets/use-css-in-hyas.md b/content/docs/styles-and-assets/use-css-in-hyas.md deleted file mode 100644 index f477e3e..0000000 --- a/content/docs/styles-and-assets/use-css-in-hyas.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -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-doks.png] -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`. \ No newline at end of file diff --git a/scripts/.gitkeep b/scripts/.gitkeep deleted file mode 100644 index e69de29..0000000