-
-
Notifications
You must be signed in to change notification settings - Fork 367
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
46 changed files
with
600 additions
and
0 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 |
---|---|---|
@@ -0,0 +1,93 @@ | ||
baseurl = "/" | ||
disableAliases = true | ||
disableHugoGeneratorInject = true | ||
enableEmoji = true | ||
enableGitInfo = false | ||
enableRobotsTXT = true | ||
languageCode = "en-US" | ||
paginate = 7 | ||
rssLimit = 10 | ||
|
||
# add redirects/headers | ||
[outputs] | ||
home = ["HTML", "RSS", "REDIRECTS", "HEADERS"] | ||
section = ["HTML", "SITEMAP"] | ||
|
||
# remove .{ext} from text/netlify | ||
[mediaTypes."text/netlify"] | ||
suffixes = [""] | ||
delimiter = "" | ||
|
||
# add output format for netlify _redirects | ||
[outputFormats.REDIRECTS] | ||
mediaType = "text/netlify" | ||
baseName = "_redirects" | ||
isPlainText = true | ||
notAlternative = true | ||
|
||
# add output format for netlify _headers | ||
[outputFormats.HEADERS] | ||
mediaType = "text/netlify" | ||
baseName = "_headers" | ||
isPlainText = true | ||
notAlternative = true | ||
|
||
# add output format for section sitemap.xml | ||
[outputFormats.SITEMAP] | ||
mediaType = "application/xml" | ||
baseName = "sitemap" | ||
isHTML = false | ||
isPlainText = true | ||
noUgly = true | ||
rel = "sitemap" | ||
|
||
[markup] | ||
[markup.goldmark] | ||
[markup.goldmark.extensions] | ||
linkify = false | ||
[markup.goldmark.renderer] | ||
unsafe = true | ||
[markup.highlight] | ||
codeFences = true | ||
guessSyntax = false | ||
hl_Lines = "" | ||
lineNoStart = 1 | ||
lineNos = false | ||
lineNumbersInTable = true | ||
noClasses = false | ||
style = "dracula" | ||
tabWidth = 4 | ||
|
||
[sitemap] | ||
changefreq = "weekly" | ||
filename = "sitemap.xml" | ||
priority = 0.5 | ||
|
||
[taxonomies] | ||
contributor = "contributors" | ||
|
||
[permalinks] | ||
blog = "/blog/:title/" | ||
|
||
[module] | ||
[[module.mounts]] | ||
source = "assets" | ||
target = "assets" | ||
[[module.mounts]] | ||
source = "static" | ||
target = "static" | ||
[[module.mounts]] | ||
source = "node_modules/lazysizes" | ||
target = "assets/js/vendor/lazysizes" | ||
[[module.mounts]] | ||
source = "node_modules/instant.page" | ||
target = "assets/js/vendor/instant.page" | ||
[[module.mounts]] | ||
source = "node_modules/lazysizes" | ||
target = "assets/js/vendor/lazysizes" | ||
[[module.mounts]] | ||
source = "node_modules/flexsearch" | ||
target = "assets/js/vendor/flexsearch" | ||
[[module.mounts]] | ||
source = "node_modules/clipboard" | ||
target = "assets/js/vendor/clipboard" |
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 = "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/gethyas" | ||
# weight = 10 | ||
|
||
[[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 = 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,47 @@ | ||
# Meta Data for SEO | ||
|
||
## Homepage | ||
title = "Doks" | ||
titleSeparator = "-" | ||
titleAddition = "Modern Documentation Theme" | ||
description = "Doks is a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default." | ||
|
||
## Open Graph + Twitter Cards | ||
images = ["doks.png"] | ||
twitterSite = "henkverlinde" | ||
twitterCreator = "henkverlinde" | ||
facebookAuthor = "verlinde.henk" | ||
facebookPublisher = "verlinde.henk" | ||
ogLocale = "en_US" | ||
|
||
## JSON-LD | ||
schemaType = "Organization" | ||
schemaLogo = "logo-doks.png" | ||
schemaTwitter = "https://twitter.com/henkverlinde" | ||
schemaLinkedIn = "https://www.linkedin.com/in/henkverlinde/" | ||
schemaGitHub = "https://github.com/h-enk" | ||
schemaSection = "blog" | ||
|
||
## Sitelinks Search Box | ||
siteLinksSearchBox = false | ||
|
||
## Chrome Browser | ||
themeColor = "#fff" | ||
|
||
# Images | ||
quality = 85 | ||
bgColor = "#fff" | ||
landscapePhotoWidths = [900, 800, 700, 600, 500] | ||
portraitPhotoWidths = [800, 700, 600, 500] | ||
lqipWidth = "20x" | ||
|
||
# Footer | ||
footer = "Powered by <a href=\"https://www.netlify.com/\">Netlify</a>, <a href=\"https://gohugo.io/\">Hugo</a>, and <a href=\"https://getdoks.org/\">Doks</a>" | ||
|
||
# Alert | ||
alert = false | ||
alertText = "Like Doks? <a class=\"alert-link\" href=\"https://github.com/h-enk/doks/stargazers\">Star on GitHub</a>. Thanks!</a>" | ||
|
||
# Edit Page | ||
docsRepo = "https://github.com/h-enk/doks" | ||
editPage = false |
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 : "Modern Documentation Theme" | ||
description: "Doks is a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default." | ||
lead: "Doks is a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default." | ||
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,8 @@ | ||
--- | ||
title: "Blog" | ||
description: "The Doks Blog." | ||
date: 2020-10-06T08:49:55+00:00 | ||
lastmod: 2020-10-06T08:49:55+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,11 @@ | ||
--- | ||
title: "Say hello to Doks 👋" | ||
description: "Introducing Doks, a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default." | ||
lead: "Introducing Doks, a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default." | ||
date: 2020-11-04T09:19:42+01:00 | ||
lastmod: 2020-11-04T09:19:42+01:00 | ||
draft: false | ||
weight: 50 | ||
images: ["say-hello-to-doks.png"] | ||
contributors: ["Henk Verlinde"] | ||
--- |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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,48 @@ | ||
--- | ||
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: `/` | ||
- 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/) | ||
|
||
## Contact the creator? | ||
|
||
Send `h-enk` a message: | ||
|
||
- [Netlify Community](https://community.netlify.com/) | ||
- [Hugo Forums](https://discourse.gohugo.io/) |
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,24 @@ | ||
--- | ||
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>." >}} | ||
|
||
## Update npm packages | ||
|
||
Bump the versions in the `devDependencies` section of `./package.json` to your liking, and run: | ||
|
||
```bash | ||
npm update | ||
``` |
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: [] | ||
--- |
Oops, something went wrong.