ResiLien
/
portails
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update for content+

This commit is contained in:
Henk Verlinde 2020-04-17 11:15:31 +02:00
parent 30377e2fa3
commit 7e6ca1fc73
20 changed files with 95 additions and 180 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -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) [![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/) [![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 - 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 - [Algolia DocSearch](https://docsearch.algolia.com/) support
- Dark/Light toggle - Dark/Light toggle
- Blog ready - Blog ready
- Easily make it your own - Easily make it your own
- All in [Hyas](https://github.com/h-enk/hyas) - All in [Hyas](https://github.com/h-enk/hyas)
See a working example at [doks.netlify.app](https://doks.netlify.app/)
## Requirements ## Requirements
Make sure all dependencies have been installed: Make sure all dependencies have been installed:
- Hugo >= 0.69.0/extended - [Hugo](https://gohugo.io/) >= 0.69.0/extended
- Node.js >= 13.11.0 - [Node.js](https://nodejs.org/) >= 13.11.0
- npm >= 6.13.7 - [Yarn](https://yarnpkg.com/) >= 1.22.4 (recommended)
- Yarn >= 1.22.4 (recommended)
## Get started ## Get started
@ -52,5 +54,6 @@ $ yarn start
- `yarn build` - Build production theme - `yarn build` - Build production theme
## Documentation ## Documentation
- [Hugo](https://gohugo.io/documentation/)
- [Hyas](https://gethyas.com/) - [Hyas](https://gethyas.com/)
- [Doks](https://doks.netlify.app/) - [Doks](https://getdoks.org/)

14
config/_default/menus.toml
View File

@ -5,16 +5,10 @@
url = "/docs/prologue/" url = "/docs/prologue/"
[[docs]] [[docs]]
name = "Basic Hyas" name = "Help"
weight = 20 weight = 20
identifier = "basic-hyas" identifier = "help"
url = "/docs/basic-hyas/" url = "/docs/help/"
[[docs]]
name = "Styles and assets"
weight = 30
identifier = "styles-and-assets"
url = "/docs/styles-and-assets/"
[[main]] [[main]]
name = "Docs" name = "Docs"
@ -29,7 +23,7 @@
[[social]] [[social]]
name = "Twitter" name = "Twitter"
pre = "<svg xmlns=\"http://www.w3.org/2000/svg\" width=\"20\" height=\"20\" viewBox=\"0 0 24 24\" fill=\"none\" stroke=\"currentColor\" stroke-width=\"2\" stroke-linecap=\"round\" stroke-linejoin=\"round\" class=\"feather feather-twitter\"><path d=\"M23 3a10.9 10.9 0 0 1-3.14 1.53 4.48 4.48 0 0 0-7.86 3v1A10.66 10.66 0 0 1 3 4s-4 9 5 13a11.64 11.64 0 0 1-7 2c9 5 20 0 20-11.5a4.5 4.5 0 0 0-.08-.83A7.72 7.72 0 0 0 23 3z\"></path></svg>" pre = "<svg xmlns=\"http://www.w3.org/2000/svg\" width=\"20\" height=\"20\" viewBox=\"0 0 24 24\" fill=\"none\" stroke=\"currentColor\" stroke-width=\"2\" stroke-linecap=\"round\" stroke-linejoin=\"round\" class=\"feather feather-twitter\"><path d=\"M23 3a10.9 10.9 0 0 1-3.14 1.53 4.48 4.48 0 0 0-7.86 3v1A10.66 10.66 0 0 1 3 4s-4 9 5 13a11.64 11.64 0 0 1-7 2c9 5 20 0 20-11.5a4.5 4.5 0 0 0-.08-.83A7.72 7.72 0 0 0 23 3z\"></path></svg>"
url = "https://twitter.com/henkverlinde" url = "https://twitter.com/getdoks"
weight = 10 weight = 10
[[social]] [[social]]

6
config/_default/params.toml
View File

@ -1,14 +1,14 @@
title = "Doks" title = "Doks"
titleSeparator = "-" titleSeparator = "-"
titleAddition = "Hugo Documentation Starter" titleAddition = "Modern Hugo Documentation Starter"
description = "Hugo starter helping you build kick-ass documentation websites." description = "Hugo starter helping you build modern documentation websites."
images = ["image-doks.png"] images = ["image-doks.png"]
twitterSite = "@henkverlinde" twitterSite = "@henkverlinde"
twitterCreator = "@henkverlinde" twitterCreator = "@henkverlinde"
ogLocale = "en_US" ogLocale = "en_US"
schemaType = "Organization" schemaType = "Organization"
schemaLogo = "logo-doks.png" schemaLogo = "logo-doks.png"
schemaTwitter = "https://twitter.com/henkverlinde" schemaTwitter = "https://twitter.com/getdoks"
schemaLinkedIn = "https://www.linkedin.com/in/henkverlinde/" schemaLinkedIn = "https://www.linkedin.com/in/henkverlinde/"
schemaSection = "news" schemaSection = "news"
siteLinksSearchBox = false siteLinksSearchBox = false

6
content/_index.md
View File

@ -1,10 +1,10 @@
--- ---
title : "Doks" title : "Doks"
description: "Hugo starter helping you build kick-ass documentation websites." description: "Hugo starter helping you build modern documentation websites."
date: 2019-12-02T13:47:16+01:00 date: 2020-04-17T08:47:36+00:00
draft: false draft: false
images: [image-doks.png] images: [image-doks.png]
lead: "Hugo starter helping you build kick-ass documentation websites." lead: "Hugo starter helping you build modern documentation websites."
--- ---
<div class="row justify-content-center"> <div class="row justify-content-center">

4
content/authors/_index.md
View File

@ -1,7 +1,7 @@
--- ---
title: "Authors" title: "Authors"
description: "" description: "The Doks Blog authors."
date: 2020-03-23T11:01:55+01:00 date: 2020-04-17T08:50:29+00:00
draft: false draft: false
images: [image-doks.png] images: [image-doks.png]
--- ---

4
content/authors/henk-verlinde/_index.md
View File

@ -1,7 +1,7 @@
--- ---
title: "Henk Verlinde" title: "Henk Verlinde"
description: "" description: "Creator of Doks."
date: 2020-03-23T11:01:55+01:00 date: 2020-04-17T08:50:45+00:00
draft: false draft: false
images: [image-doks.png] images: [image-doks.png]
--- ---

4
content/blog/_index.md
View File

@ -1,7 +1,7 @@
--- ---
title: "Blog" title: "Blog"
description: "" description: "The Doks Blog."
date: 2019-12-02T13:47:16+01:00 date: 2020-04-17T08:49:55+00:00
draft: false draft: false
images: [image-doks.png] images: [image-doks.png]
--- ---

6
content/blog/say-hello-to-doks/index.md
View File

@ -1,8 +1,8 @@
--- ---
title: "Say hello to Doks 👋" title: "Say hello to Doks 👋"
description: "Doks is a Hugo starter helping you build kick-ass documentation websites." description: "Doks is a Hugo starter helping you build modern documentation websites."
lead: "Doks is a Hugo starter helping you build kick-ass documentation websites." lead: "Doks is a Hugo starter helping you build modern documentation websites."
date: 2020-03-14T10:12:13+02:00 date: 2020-04-17T08:50:12+00:00
draft: false draft: false
images: [image-doks.png] images: [image-doks.png]
authors: ["Henk Verlinde"] authors: ["Henk Verlinde"]

6
content/docs/_index.md
View File

@ -1,8 +1,8 @@
--- ---
title : "Docs" title : "Docs"
description: "Hugo boilerplate helping you build fast, robust, and flexible websites." description: "Docs Doks."
lead: "Hugo boilerplate helping you build fast, robust, and flexible websites." lead: ""
date: 2019-12-02T13:47:16+01:00 date: 2020-04-17T08:48:23+00:00
draft: false draft: false
images: [image-doks.png] images: [image-doks.png]
--- ---

8
content/docs/basic-hyas/_index.md
View File

@ -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]
---

55
content/docs/basic-hyas/directory-structure.md
View File

@ -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.

13
content/docs/basic-hyas/layouts.md
View File

@ -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
---

13
content/docs/basic-hyas/project-configuration.md
View File

@ -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
---

8
content/docs/help/_index.md Normal file
View File

@ -0,0 +1,8 @@
---
title: "Help"
description: "Help Doks."
lead: ""
date: 2020-04-17T08:49:15+00:00
draft: false
images: [image-doks.png]
---

22
content/docs/help/faq.md Normal file
View File

@ -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.

6
content/docs/prologue/_index.md
View File

@ -1,8 +1,8 @@
--- ---
title : "Prologue" title : "Prologue"
description: "Hugo boilerplate helping you build fast, robust, and flexible websites." description: "Prologue Doks."
lead: "Hugo boilerplate helping you build fast, robust, and flexible websites." lead: ""
date: 2019-12-02T13:47:16+01:00 date: 2020-04-17T08:48:45+00:00
draft: false draft: false
images: [image-doks.png] images: [image-doks.png]
--- ---

59
content/docs/prologue/introduction.md
View File

@ -1,8 +1,8 @@
--- ---
title: "Introduction" title: "Introduction"
description: "Hugo boilerplate helping you build fast, robust, and flexible websites." description: "Introduction Doks."
lead: "Hugo boilerplate helping you build fast, robust, and flexible websites." lead: "Doks is a Hugo starter helping you build modern documentation websites."
date: 2020-01-07T16:23:23+01:00 date: 2020-04-17T08:48:57+00:00
draft: false draft: false
images: [image-doks.png] images: [image-doks.png]
menu: menu:
@ -12,49 +12,46 @@ weight: 010
toc: true toc: true
--- ---
<div class="card bg-light border-0"> ## Features
<div class="card-body"> - Lightweight code base
👉 This is some text within a card body. - 100 scores Google Lighthouse
</div> - A+ scores [Mozilla Observatory](https://observatory.mozilla.org/)
</div> - [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/)
- Bootstrap Sass (no JavaScript) and Autoprefixer
- Check Sass and JavaScript for errors ## Requirements
- 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)
## Prerequisites
Make sure all dependencies have been installed: Make sure all dependencies have been installed:
- Hugo >= 0.62.2/extended - [Hugo](https://gohugo.io/) >= 0.69.0/extended
- Node.js >= 10.16.0 - [Node.js](https://nodejs.org/) >= 13.11.0
- npm >= 6.9.0 - [Yarn](https://yarnpkg.com/) >= 1.22.4 (recommended)
- Yarn >= 1.21.1 (recommended)
## Internal links ## Get started
[Check out the directory structure]({{< ref "docs/basic-hyas/directory-structure.md" >}}). Create a new Doks project:
## How to install
Create a new Hyas project:
```bash ```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: Install dependencies:
```bash ```bash
yarn install # @ my-doks-site/
$ yarn install
``` ```
Build development theme with live reloading and injection: Build development theme with live reloading and injection:
```bash ```bash
yarn start # @ my-doks-site/
$ yarn start
``` ```
### Other commands ### Other commands
@ -63,5 +60,7 @@ yarn start
- `yarn clean` - Delete temporary directories - `yarn clean` - Delete temporary directories
- `yarn build` - Build production theme - `yarn build` - Build production theme
## Alternatives ## Documentation
- [Atlas](https://github.com/indigotree/atlas). - [Hugo](https://gohugo.io/documentation/)
- [Hyas](https://gethyas.com/)
- [Doks](https://getdoks.org/)

8
content/docs/styles-and-assets/_index.md
View File

@ -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]
---

14
content/docs/styles-and-assets/use-css-in-hyas.md
View File

@ -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`.

0
scripts/.gitkeep
View File