This repository has been archived by the owner on Sep 28, 2023. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 34
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
16 changed files
with
484 additions
and
3 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
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 |
---|---|---|
@@ -0,0 +1,39 @@ | ||
[[docs]] | ||
name = "Prologue" | ||
weight = 10 | ||
identifier = "prologue" | ||
url = "/docs/prologue/" | ||
|
||
[[docs]] | ||
name = "Help" | ||
weight = 60 | ||
identifier = "help" | ||
url = "/docs/help/" | ||
|
||
[[main]] | ||
name = "Docs" | ||
url = "/docs/prologue/introduction/" | ||
weight = 10 | ||
|
||
# [[main]] | ||
# name = "Blog" | ||
# url = "/blog/" | ||
# weight = 20 | ||
|
||
[[social]] | ||
name = "GitHub" | ||
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-github\"><path d=\"M9 19c-5 1.5-5-2.5-7-3m14 6v-3.87a3.37 3.37 0 0 0-.94-2.61c3.14-.35 6.44-1.54 6.44-7A5.44 5.44 0 0 0 20 4.77 5.07 5.07 0 0 0 19.91 1S18.73.65 16 2.48a13.38 13.38 0 0 0-7 0C6.27.65 5.09 1 5.09 1A5.07 5.07 0 0 0 5 4.77a5.44 5.44 0 0 0-1.5 3.78c0 5.42 3.3 6.61 6.44 7A3.37 3.37 0 0 0 9 18.13V22\"></path></svg>" | ||
url = "https://github.com/h-enk/doks" | ||
post = "v0.1.0" | ||
weight = 10 | ||
|
||
[[social]] | ||
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>" | ||
url = "https://twitter.com/getdoks" | ||
weight = 20 | ||
|
||
# [[footer]] | ||
# name = "Privacy" | ||
# url = "/privacy-policy/" | ||
# weight = 10 |
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 |
---|---|---|
@@ -0,0 +1,10 @@ | ||
--- | ||
title : "Modern documentatie-thema" | ||
description: "Doks is een Hugo-thema waarmee je moderne documentatie-websites kunt bouwen die veilig, snel en klaar voor SEO zijn — standaard." | ||
lead: "Doks is een Hugo-thema waarmee je moderne documentatie-websites kunt bouwen die veilig, snel en klaar voor SEO zijn — standaard." | ||
date: 2020-10-06T08:47:36+00:00 | ||
lastmod: 2020-10-06T08:47:36+00:00 | ||
draft: false | ||
images: [] | ||
--- | ||
|
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 |
---|---|---|
@@ -0,0 +1,10 @@ | ||
--- | ||
title: "Contact" | ||
description: "Drop us an email." | ||
date: 2020-08-27T19:25:12+02:00 | ||
lastmod: 2020-08-27T19:25:12+02:00 | ||
draft: true | ||
images: [] | ||
--- | ||
|
||
{{< email user="hello" domain="getdoks.org" >}} |
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 |
---|---|---|
@@ -0,0 +1,10 @@ | ||
--- | ||
title: "Contributors" | ||
description: "The Doks contributors." | ||
date: 2020-10-06T08:50:29+00:00 | ||
lastmod: 2020-10-06T08:50:29+00:00 | ||
draft: false | ||
images: [] | ||
--- | ||
|
||
The Doks contributors. |
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 |
---|---|---|
@@ -0,0 +1,12 @@ | ||
--- | ||
title: "Henk Verlinde" | ||
description: "Creator of Hyas." | ||
date: 2020-10-06T08:50:45+00:00 | ||
lastmod: 2020-10-06T08:50:45+00:00 | ||
draft: false | ||
images: [] | ||
--- | ||
|
||
Creator of Hyas. | ||
|
||
[@HenkVerlinde](https://twitter.com/henkverlinde) |
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 |
---|---|---|
@@ -0,0 +1,9 @@ | ||
--- | ||
title : "Docs" | ||
description: "Docs Doks." | ||
lead: "" | ||
date: 2020-10-06T08:48:23+00:00 | ||
lastmod: 2020-10-06T08:48:23+00:00 | ||
draft: false | ||
images: [] | ||
--- |
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 |
---|---|---|
@@ -0,0 +1,9 @@ | ||
--- | ||
title: "Help" | ||
description: "Help Doks." | ||
lead: "" | ||
date: 2020-10-06T08:49:15+00:00 | ||
lastmod: 2020-10-06T08:49:15+00:00 | ||
draft: false | ||
images: [] | ||
--- |
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 |
---|---|---|
@@ -0,0 +1,50 @@ | ||
--- | ||
title: "FAQ" | ||
description: "Answers to frequently asked questions." | ||
lead: "Answers to frequently asked questions." | ||
date: 2020-10-06T08:49:31+00:00 | ||
lastmod: 2020-10-06T08:49:31+00:00 | ||
draft: false | ||
images: [] | ||
menu: | ||
docs: | ||
parent: "help" | ||
weight: 630 | ||
toc: true | ||
--- | ||
|
||
## Hyas? | ||
|
||
Doks is a [Hyas theme](https://gethyas.com/themes/) build by the creator of Hyas. | ||
|
||
## Footer notice? | ||
|
||
Please keep it in place. | ||
|
||
## Keyboard shortcuts for search? | ||
|
||
- focus: `Ctrl + /` | ||
- select: `↓` and `↑` | ||
- open: `Enter` | ||
- close: `Esc` | ||
|
||
## Other documentation? | ||
|
||
- [Netlify](https://docs.netlify.com/) | ||
- [Hugo](https://gohugo.io/documentation/) | ||
|
||
## Can I get support? | ||
|
||
Create a topic: | ||
|
||
- [Netlify Community](https://community.netlify.com/) | ||
- [Hugo Forums](https://discourse.gohugo.io/) | ||
- [Doks Discussions](https://github.com/h-enk/doks/discussions) | ||
|
||
## Contact the creator? | ||
|
||
Send `h-enk` a message: | ||
|
||
- [Netlify Community](https://community.netlify.com/) | ||
- [Hugo Forums](https://discourse.gohugo.io/) | ||
- [Doks Discussions](https://github.com/h-enk/doks/discussions) |
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 |
---|---|---|
@@ -0,0 +1,32 @@ | ||
--- | ||
title: "How to Update" | ||
description: "Regularly update the installed npm packages to keep your Doks website stable, usable, and secure." | ||
lead: "Regularly update the installed npm packages to keep your Doks website stable, usable, and secure." | ||
date: 2020-11-12T13:26:54+01:00 | ||
lastmod: 2020-11-12T13:26:54+01:00 | ||
draft: false | ||
images: [] | ||
menu: | ||
docs: | ||
parent: "help" | ||
weight: 610 | ||
toc: true | ||
--- | ||
|
||
{{< alert icon="💡" text="Learn more about <a href=\"https://docs.npmjs.com/about-semantic-versioning\">semantic versioning</a> and <a href=\"https://docs.npmjs.com/cli/v6/using-npm/semver#advanced-range-syntax\">advanced range syntax</a>." />}} | ||
|
||
## Check for outdated packages | ||
|
||
The [`npm outdated`](https://docs.npmjs.com/cli/v7/commands/npm-outdated) command will check the registry to see if any (or, specific) installed packages are currently outdated: | ||
|
||
```bash | ||
npm outdated [[<@scope>/]<pkg> ...] | ||
``` | ||
|
||
## Update packages | ||
|
||
The [`npm update`](https://docs.npmjs.com/cli/v7/commands/npm-update) command will update all the packages listed to the latest version (specified by the tag config), respecting semver: | ||
|
||
```bash | ||
npm update [<pkg>...] | ||
``` |
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 |
---|---|---|
@@ -0,0 +1,30 @@ | ||
--- | ||
title: "Troubleshooting" | ||
description: "Solutions to common problems." | ||
lead: "Solutions to common problems." | ||
date: 2020-11-12T15:22:20+01:00 | ||
lastmod: 2020-11-12T15:22:20+01:00 | ||
draft: false | ||
images: [] | ||
menu: | ||
docs: | ||
parent: "help" | ||
weight: 620 | ||
toc: true | ||
--- | ||
|
||
## Problems updating npm packages | ||
|
||
Delete the `./node_modules` folder, and run again: | ||
|
||
```bash | ||
npm install | ||
``` | ||
|
||
## Problems with cache | ||
|
||
Delete the temporary directories: | ||
|
||
```bash | ||
npm run clean | ||
``` |
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 |
---|---|---|
@@ -0,0 +1,9 @@ | ||
--- | ||
title : "Prologue" | ||
description: "Prologue Doks." | ||
lead: "" | ||
date: 2020-10-06T08:48:45+00:00 | ||
lastmod: 2020-10-06T08:48:45+00:00 | ||
draft: false | ||
images: [] | ||
--- |
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 |
---|---|---|
@@ -0,0 +1,98 @@ | ||
--- | ||
title: "Commands" | ||
description: "Doks comes with commands for common tasks." | ||
lead: "Doks comes with commands for common tasks." | ||
date: 2020-10-13T15:21:01+02:00 | ||
lastmod: 2020-10-13T15:21:01+02:00 | ||
draft: false | ||
images: [] | ||
menu: | ||
docs: | ||
parent: "prologue" | ||
weight: 130 | ||
toc: true | ||
--- | ||
|
||
{{< alert icon="💡" text="You can change the commands in the scripts section of `./package.json`." />}} | ||
|
||
## create | ||
|
||
Create new content for your site: | ||
|
||
```bash | ||
npm run create [path] [flags] | ||
``` | ||
|
||
See also the Hugo docs: [hugo new](https://gohugo.io/commands/hugo_new/). | ||
|
||
## lint | ||
|
||
Check scripts, styles, and markdown for errors: | ||
|
||
```bash | ||
npm run lint | ||
``` | ||
|
||
### scripts | ||
|
||
Check scripts for errors: | ||
|
||
```bash | ||
npm run lint:scripts [-- --fix] | ||
``` | ||
|
||
### styles | ||
|
||
Check styles for errors: | ||
|
||
```bash | ||
npm run lint:styles [-- --fix] | ||
``` | ||
|
||
### markdown | ||
|
||
Check markdown for errors: | ||
|
||
```bash | ||
npm run lint:markdown [-- --fix] | ||
``` | ||
|
||
## clean | ||
|
||
Delete temporary directories: | ||
|
||
```bash | ||
npm run clean | ||
``` | ||
|
||
## start | ||
|
||
Start local development server: | ||
|
||
```bash | ||
npm run start | ||
``` | ||
|
||
## build | ||
|
||
Build production website: | ||
|
||
```bash | ||
npm run build | ||
``` | ||
|
||
### functions | ||
|
||
Build Lambda functions: | ||
|
||
```bash | ||
npm run build:functions | ||
``` | ||
|
||
### preview | ||
|
||
Build production website including draft and future content: | ||
|
||
```bash | ||
npm run build:preview | ||
``` |
Oops, something went wrong.