feat: update for doks v1.0.0-alpha.1
This commit is contained in:
Henk Verlinde
11
content/about.md
Normal file
11
content/about.md
Normal file
@ -0,0 +1,11 @@
|
||||
---
|
||||
title: "About"
|
||||
description: ""
|
||||
date: 2023-04-14T14:51:16+02:00
|
||||
lastmod: 2023-04-14T14:51:16+02:00
|
||||
draft: false
|
||||
images: []
|
||||
type: "about"
|
||||
---
|
||||
|
||||
[About]
|
||||
10
content/blog/_index.md
Normal file
10
content/blog/_index.md
Normal file
@ -0,0 +1,10 @@
|
||||
---
|
||||
title: "The Doks Blog"
|
||||
headline: "Blog"
|
||||
description: "Get all the latest news from Doks."
|
||||
summary: "Get all the latest news from Doks."
|
||||
date: 2020-10-06T08:49:55+00:00
|
||||
lastmod: 2020-10-06T08:49:55+00:00
|
||||
draft: false
|
||||
images: []
|
||||
---
|
||||
182
content/blog/diagrams-math-typesetting/index.md
Normal file
182
content/blog/diagrams-math-typesetting/index.md
Normal file
@ -0,0 +1,182 @@
|
||||
---
|
||||
title: "Diagrams and Math Typesetting"
|
||||
description: "This cheat sheet provides a quick overview of diagrams and math typesetting."
|
||||
summary: "This cheat sheet provides a quick overview of diagrams and math typesetting."
|
||||
date: 2023-03-31T13:45:33+02:00
|
||||
lastmod: 2023-03-31T13:45:33+02:00
|
||||
draft: true
|
||||
weight: 50
|
||||
images: []
|
||||
categories: []
|
||||
tags: []
|
||||
contributors: ["Henk Verlinde"]
|
||||
pinned: false
|
||||
homepage: false
|
||||
katex: true
|
||||
---
|
||||
|
||||
## GoAT
|
||||
|
||||
### Example 1
|
||||
|
||||
````md
|
||||
```goat
|
||||
. . . .--- 1 .-- 1 / 1
|
||||
/ \ | | .---+ .-+ +
|
||||
/ \ .---+---. .--+--. | '--- 2 | '-- 2 / \ 2
|
||||
+ + | | | | ---+ ---+ +
|
||||
/ \ / \ .-+-. .-+-. .+. .+. | .--- 3 | .-- 3 \ / 3
|
||||
/ \ / \ | | | | | | | | '---+ '-+ +
|
||||
1 2 3 4 1 2 3 4 1 2 3 4 '--- 4 '-- 4 \ 4
|
||||
|
||||
```
|
||||
````
|
||||
|
||||
```goat
|
||||
. . . .--- 1 .-- 1 / 1
|
||||
/ \ | | .---+ .-+ +
|
||||
/ \ .---+---. .--+--. | '--- 2 | '-- 2 / \ 2
|
||||
+ + | | | | ---+ ---+ +
|
||||
/ \ / \ .-+-. .-+-. .+. .+. | .--- 3 | .-- 3 \ / 3
|
||||
/ \ / \ | | | | | | | | '---+ '-+ +
|
||||
1 2 3 4 1 2 3 4 1 2 3 4 '--- 4 '-- 4 \ 4
|
||||
|
||||
```
|
||||
|
||||
### Example 2
|
||||
|
||||
````md
|
||||
```goat
|
||||
.---. .-. .-. .-. .-.
|
||||
| A +----->| 1 +<---->| 2 |<----+ 4 +------------------. | 8 |
|
||||
'---' '-' '+' '-' | '-'
|
||||
| ^ | ^
|
||||
v | v |
|
||||
.-. .-+-. .-. .-+-. .-. .+. .---.
|
||||
| 3 +---->| B |<----->| 5 +---->| C +---->| 6 +---->| 7 |<---->| D |
|
||||
'-' '---' '-' '---' '-' '-' '---'
|
||||
```
|
||||
````
|
||||
|
||||
```goat
|
||||
.---. .-. .-. .-. .-.
|
||||
| A +----->| 1 +<---->| 2 |<----+ 4 +------------------. | 8 |
|
||||
'---' '-' '+' '-' | '-'
|
||||
| ^ | ^
|
||||
v | v |
|
||||
.-. .-+-. .-. .-+-. .-. .+. .---.
|
||||
| 3 +---->| B |<----->| 5 +---->| C +---->| 6 +---->| 7 |<---->| D |
|
||||
'-' '---' '-' '---' '-' '-' '---'
|
||||
```
|
||||
|
||||
## Mermaid
|
||||
|
||||
### Example 1
|
||||
|
||||
````md
|
||||
```mermaid
|
||||
graph TD
|
||||
A[Hard] -->|Text| B(Round)
|
||||
B --> C{Decision}
|
||||
C -->|One| D[Result 1]
|
||||
C -->|Two| E[Result 2]
|
||||
```
|
||||
````
|
||||
|
||||
Renders into:
|
||||
|
||||
```mermaid
|
||||
graph TD
|
||||
A[Hard] -->|Text| B(Round)
|
||||
B --> C{Decision}
|
||||
C -->|One| D[Result 1]
|
||||
C -->|Two| E[Result 2]
|
||||
```
|
||||
|
||||
### Example 2
|
||||
|
||||
````md
|
||||
```mermaid
|
||||
sequenceDiagram
|
||||
participant Alice
|
||||
participant Bob
|
||||
Alice->>John: Hello John, how are you?
|
||||
loop Healthcheck
|
||||
John->>John: Fight against hypochondria
|
||||
end
|
||||
Note right of John: Rational thoughts <br/>prevail!
|
||||
John-->>Alice: Great!
|
||||
John->>Bob: How about you?
|
||||
Bob-->>John: Jolly good!
|
||||
```
|
||||
````
|
||||
|
||||
Renders into:
|
||||
|
||||
```mermaid
|
||||
sequenceDiagram
|
||||
participant Alice
|
||||
participant Bob
|
||||
Alice->>John: Hello John, how are you?
|
||||
loop Healthcheck
|
||||
John->>John: Fight against hypochondria
|
||||
end
|
||||
Note right of John: Rational thoughts <br/>prevail!
|
||||
John-->>Alice: Great!
|
||||
John->>Bob: How about you?
|
||||
Bob-->>John: Jolly good!
|
||||
```
|
||||
|
||||
## KaTeX
|
||||
|
||||
The default display mode delimiters are `$$` or `\\[` and `\\]`.
|
||||
|
||||
### Example 1
|
||||
|
||||
```md
|
||||
$$\sum_{x=1}^5 y^z$$
|
||||
```
|
||||
|
||||
Renders into:
|
||||
|
||||
$$\sum_{x=1}^5 y^z$$
|
||||
|
||||
### Example 2
|
||||
|
||||
```md
|
||||
$$
|
||||
\begin{equation*}
|
||||
n \sim 10^{18} \mathrm{cm^{-3}} \left(\frac{100\mathrm{km}}{R}\right)^2 \left(\frac{10\mathrm{MeV}}{\langle E \rangle}\right).
|
||||
\end{equation*}
|
||||
$$
|
||||
```
|
||||
|
||||
Renders into:
|
||||
|
||||
$$
|
||||
\begin{equation*}
|
||||
n \sim 10^{18} \mathrm{cm^{-3}} \left(\frac{100\mathrm{km}}{R}\right)^2 \left(\frac{10\mathrm{MeV}}{\langle E \rangle}\right).
|
||||
\end{equation*}
|
||||
$$
|
||||
|
||||
### Example 3
|
||||
|
||||
```md
|
||||
\\[\int_a^b f(x)\\]
|
||||
```
|
||||
|
||||
Renders into:
|
||||
|
||||
\\[\int_a^b f(x)\\]
|
||||
|
||||
### Example 4
|
||||
|
||||
Inline mode delimiters are `\\(` and `\\)`.
|
||||
|
||||
```md
|
||||
Mass–energy relation: \\(E = mc^2\\)
|
||||
```
|
||||
|
||||
Renders into:
|
||||
|
||||
Mass–energy relation: \\(E = mc^2\\)
|
||||
109
content/blog/markdown-basic-syntax/index.md
Normal file
109
content/blog/markdown-basic-syntax/index.md
Normal file
@ -0,0 +1,109 @@
|
||||
---
|
||||
title: "Markdown Basic Syntax"
|
||||
description: "This Markdown cheat sheet provides a quick overview of all basic Markdown syntax elements."
|
||||
summary: "This Markdown cheat sheet provides a quick overview of all basic Markdown syntax elements."
|
||||
date: 2023-03-31T12:06:49+02:00
|
||||
lastmod: 2023-03-31T12:06:49+02:00
|
||||
draft: false
|
||||
weight: 50
|
||||
images: ["markdown-guide.jpg"]
|
||||
categories: []
|
||||
tags: []
|
||||
contributors: ["Henk Verlinde"]
|
||||
pinned: false
|
||||
homepage: false
|
||||
---
|
||||
|
||||
If you need more information about any of these elements, refer to the reference guide for [basic syntax](https://www.markdownguide.org/basic-syntax).
|
||||
|
||||
## Heading
|
||||
|
||||
```md
|
||||
# H1
|
||||
## H2
|
||||
### H3
|
||||
```
|
||||
|
||||
# H1
|
||||
## H2
|
||||
### H3
|
||||
|
||||
## Bold
|
||||
|
||||
```md
|
||||
**bold text**
|
||||
```
|
||||
|
||||
**bold text**
|
||||
|
||||
## Italic
|
||||
|
||||
```md
|
||||
*italicized text*
|
||||
```
|
||||
|
||||
*italicized text*
|
||||
|
||||
## Blockquote
|
||||
|
||||
```md
|
||||
> blockquote
|
||||
```
|
||||
|
||||
> blockquote
|
||||
|
||||
## Ordered List
|
||||
|
||||
```md
|
||||
1. First item
|
||||
2. Second item
|
||||
3. Third item
|
||||
```
|
||||
|
||||
1. First item
|
||||
2. Second item
|
||||
3. Third item
|
||||
|
||||
## Unordered List
|
||||
|
||||
```md
|
||||
- First item
|
||||
- Second item
|
||||
- Third item
|
||||
```
|
||||
|
||||
- First item
|
||||
- Second item
|
||||
- Third item
|
||||
|
||||
## Code
|
||||
|
||||
```bash
|
||||
`code`
|
||||
```
|
||||
|
||||
`code`
|
||||
|
||||
## Horizontal Rule
|
||||
|
||||
```md
|
||||
---
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Link
|
||||
|
||||
```md
|
||||
[Markdown Guide](https://www.markdownguide.org)
|
||||
```
|
||||
|
||||
[Markdown Guide](https://www.markdownguide.org)
|
||||
|
||||
## Image
|
||||
|
||||
```md
|
||||
|
||||
```
|
||||
|
||||
|
||||
BIN
content/blog/markdown-basic-syntax/markdown-guide.jpg
Normal file
BIN
content/blog/markdown-basic-syntax/markdown-guide.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 79 KiB |
148
content/blog/markdown-extended-syntax/index.md
Normal file
148
content/blog/markdown-extended-syntax/index.md
Normal file
@ -0,0 +1,148 @@
|
||||
---
|
||||
title: "Markdown Extended Syntax"
|
||||
description: "This Markdown cheat sheet provides a quick overview of all extended Markdown syntax elements."
|
||||
summary: "This Markdown cheat sheet provides a quick overview of all extended Markdown syntax elements."
|
||||
date: 2023-03-31T12:07:15+02:00
|
||||
lastmod: 2023-03-31T12:07:15+02:00
|
||||
draft: false
|
||||
weight: 50
|
||||
images: []
|
||||
categories: []
|
||||
tags: []
|
||||
contributors: ["Henk Verlinde"]
|
||||
pinned: false
|
||||
homepage: false
|
||||
---
|
||||
|
||||
If you need more information about any of these elements, refer to the reference guide for [extended syntax](https://www.markdownguide.org/extended-syntax).
|
||||
|
||||
## Table
|
||||
|
||||
```md
|
||||
| Syntax | Description |
|
||||
| ----------- | ----------- |
|
||||
| Header | Title |
|
||||
| Paragraph | Text |
|
||||
{.table .table-striped}
|
||||
```
|
||||
|
||||
| Syntax | Description |
|
||||
| ----------- | ----------- |
|
||||
| Header | Title |
|
||||
| Paragraph | Text |
|
||||
{.table .table-striped}
|
||||
|
||||
## Fenced Code Block
|
||||
|
||||
````md
|
||||
```json
|
||||
{
|
||||
"firstName": "John",
|
||||
"lastName": "Smith",
|
||||
"age": 25
|
||||
}
|
||||
```
|
||||
````
|
||||
|
||||
```json
|
||||
{
|
||||
"firstName": "John",
|
||||
"lastName": "Smith",
|
||||
"age": 25
|
||||
}
|
||||
```
|
||||
|
||||
## Footnote
|
||||
|
||||
```md
|
||||
Here's a sentence with a footnote. [^1]
|
||||
|
||||
[^1]: This is the footnote.
|
||||
```
|
||||
|
||||
Here's a sentence with a footnote. [^1]
|
||||
|
||||
[^1]: This is the footnote.
|
||||
|
||||
## Heading ID
|
||||
|
||||
```md
|
||||
### My Great Heading{#custom-id}
|
||||
```
|
||||
|
||||
### My Great Heading{#custom-id}
|
||||
|
||||
```html
|
||||
<h3 id="custom-id">My Great Heading</h3>
|
||||
```
|
||||
|
||||
## Definition List
|
||||
|
||||
```md
|
||||
term
|
||||
: definition
|
||||
```
|
||||
|
||||
term
|
||||
: definition
|
||||
|
||||
## Strikethrough
|
||||
|
||||
```md
|
||||
~~The world is flat.~~
|
||||
```
|
||||
|
||||
~~The world is flat.~~
|
||||
|
||||
## Task List
|
||||
|
||||
```md
|
||||
- [x] Write the press release
|
||||
- [ ] Update the website
|
||||
- [ ] Contact the media
|
||||
{.list-unstyled}
|
||||
```
|
||||
|
||||
- [x] Write the press release
|
||||
- [ ] Update the website
|
||||
- [ ] Contact the media
|
||||
{.list-unstyled}
|
||||
|
||||
## Emoji
|
||||
|
||||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">That is so funny! :joy:
|
||||
</span></span></code></pre></div>
|
||||
|
||||
That is so funny! :joy:
|
||||
|
||||
(See also [Copying and Pasting Emoji](https://www.markdownguide.org/extended-syntax/#copying-and-pasting-emoji))
|
||||
|
||||
## Highlight
|
||||
|
||||
```md
|
||||
I need to highlight these <mark>very important words</mark>.
|
||||
```
|
||||
|
||||
I need to highlight these <mark>very important words</mark>.
|
||||
|
||||
(See also [Hugo Markdown Support](https://www.markdownguide.org/tools/hugo/#hugo-markdown-support))
|
||||
|
||||
## Subscript
|
||||
|
||||
```md
|
||||
H<sub>2</sub>O
|
||||
```
|
||||
|
||||
H<sub>2</sub>O
|
||||
|
||||
(See also [Hugo Markdown Support](https://www.markdownguide.org/tools/hugo/#hugo-markdown-support))
|
||||
|
||||
## Superscript
|
||||
|
||||
```md
|
||||
X<sup>2</sup>
|
||||
```
|
||||
|
||||
X<sup>2</sup>
|
||||
|
||||
(See also [Hugo Markdown Support](https://www.markdownguide.org/tools/hugo/#hugo-markdown-support))
|
||||
@ -1,14 +1,14 @@
|
||||
---
|
||||
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."
|
||||
excerpt: "Introducing Doks, a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default."
|
||||
summary: "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: []
|
||||
categories: ["News"]
|
||||
tags: ["security", "performance", "SEO"]
|
||||
categories: []
|
||||
tags: []
|
||||
contributors: ["Henk Verlinde"]
|
||||
pinned: false
|
||||
homepage: false
|
||||
179
content/blog/shortcodes/index.md
Normal file
179
content/blog/shortcodes/index.md
Normal file
@ -0,0 +1,179 @@
|
||||
---
|
||||
title: "Shortcodes"
|
||||
description: "This cheat sheet provides a quick overview of all available Doks shortcodes."
|
||||
summary: "This cheat sheet provides a quick overview of all available Doks shortcodes."
|
||||
date: 2023-03-31T12:07:31+02:00
|
||||
lastmod: 2023-03-31T12:07:31+02:00
|
||||
draft: false
|
||||
weight: 50
|
||||
images: []
|
||||
categories: []
|
||||
tags: []
|
||||
contributors: ["Henk Verlinde"]
|
||||
pinned: false
|
||||
homepage: false
|
||||
---
|
||||
|
||||
## Alert
|
||||
|
||||
### Default
|
||||
|
||||
```md
|
||||
{{</* alert */>}}
|
||||
**Note**: Advisories for malware are currently in beta and subject to change.
|
||||
{{</* /alert */>}}
|
||||
```
|
||||
|
||||
{{< alert >}}
|
||||
**Note**: Advisories for malware are currently in beta and subject to change.
|
||||
{{< /alert >}}
|
||||
|
||||
### Context
|
||||
|
||||
```md
|
||||
{{</* alert context="primary" */>}}
|
||||
**Note**: Advisories for malware are currently in beta and subject to change.
|
||||
{{</* /alert */>}}
|
||||
```
|
||||
|
||||
{{< alert context="primary">}}
|
||||
**Note**: Advisories for malware are currently in beta and subject to change.
|
||||
{{< /alert >}}
|
||||
|
||||
### Icon
|
||||
|
||||
```md
|
||||
{{</* alert icon="👉" */>}}
|
||||
Advisories for malware are currently in beta and subject to change.
|
||||
{{</* /alert */>}}
|
||||
```
|
||||
|
||||
{{< alert icon="👉" >}}
|
||||
Advisories for malware are currently in beta and subject to change.
|
||||
{{< /alert >}}
|
||||
|
||||
## Details
|
||||
|
||||
```md
|
||||
{{</* details "How will we conduct IEP and 504 meetings?" */>}}
|
||||
All meetings will be held *remotely*.
|
||||
{{</* /details */>}}
|
||||
```
|
||||
|
||||
{{< details "How will we conduct IEP and 504 meetings?" >}}
|
||||
All meetings will be held *remotely*.
|
||||
{{< /details >}}
|
||||
|
||||
## Tabs
|
||||
|
||||
Run the following command in your terminal to start our handy install wizard, `create-hyas`.
|
||||
|
||||
````md
|
||||
{{</* tabs "create-new-site" */>}}
|
||||
{{</* tab "npm" */>}}
|
||||
|
||||
```bash
|
||||
npm create hyas@latest
|
||||
```
|
||||
|
||||
{{</* /tab */>}}
|
||||
{{</* tab "pnpm" */>}}
|
||||
|
||||
```bash
|
||||
pnpm create hyas@latest
|
||||
```
|
||||
|
||||
{{</* /tab */>}}
|
||||
{{</* tab "Yarn" */>}}
|
||||
|
||||
```bash
|
||||
yarn create hyas
|
||||
```
|
||||
|
||||
{{</* /tab */>}}
|
||||
{{</* /tabs */>}}
|
||||
````
|
||||
|
||||
{{< tabs "create-new-site" >}}
|
||||
{{< tab "npm" >}}
|
||||
|
||||
```bash
|
||||
npm create hyas@latest
|
||||
```
|
||||
|
||||
{{< /tab >}}
|
||||
{{< tab "pnpm" >}}
|
||||
|
||||
```bash
|
||||
pnpm create hyas@latest
|
||||
```
|
||||
|
||||
{{< /tab >}}
|
||||
{{< tab "Yarn" >}}
|
||||
|
||||
```bash
|
||||
yarn create hyas
|
||||
```
|
||||
|
||||
{{< /tab >}}
|
||||
{{< /tabs >}}
|
||||
|
||||
`cd` into your new project directory to begin using Hyas. Install your dependencies before continuing.
|
||||
|
||||
````md
|
||||
{{</* tabs "install-dependencies" */>}}
|
||||
{{</* tab "npm" */>}}
|
||||
|
||||
```bash
|
||||
npm install
|
||||
```
|
||||
|
||||
{{</* /tab */>}}
|
||||
{{</* tab "pnpm" */>}}
|
||||
|
||||
```bash
|
||||
pnpm install
|
||||
```
|
||||
|
||||
{{</* /tab */>}}
|
||||
{{</* tab "Yarn" */>}}
|
||||
|
||||
```bash
|
||||
yarn install
|
||||
```
|
||||
|
||||
{{</* /tab */>}}
|
||||
{{</* /tabs */>}}
|
||||
````
|
||||
|
||||
{{< tabs "install-dependencies" >}}
|
||||
{{< tab "npm" >}}
|
||||
|
||||
```bash
|
||||
npm install
|
||||
```
|
||||
|
||||
{{< /tab >}}
|
||||
{{< tab "pnpm" >}}
|
||||
|
||||
```bash
|
||||
pnpm install
|
||||
```
|
||||
|
||||
{{< /tab >}}
|
||||
{{< tab "Yarn" >}}
|
||||
|
||||
```bash
|
||||
yarn install
|
||||
```
|
||||
|
||||
{{< /tab >}}
|
||||
{{< /tabs >}}
|
||||
|
||||
## Video
|
||||
|
||||
```md
|
||||
{{</* video ratio="16x9" attributes="controls autoplay muted" webm-src="videos/flower.webm" mp4-src="videos/flower.mp4" */>}}
|
||||
```
|
||||
|
||||
{{< video ratio="16x9" attributes="controls autoplay muted" webm-src="videos/flower.webm" mp4-src="videos/flower.mp4" >}}
|
||||
@ -1,10 +1,9 @@
|
||||
---
|
||||
title: "Contributors"
|
||||
description: "The Doks contributors."
|
||||
summary: "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.
|
||||
@ -1,12 +1,12 @@
|
||||
---
|
||||
title: "Henk Verlinde"
|
||||
description: "Creator of Hyas."
|
||||
description: "Creator of Doks."
|
||||
summary: "Creator of Doks."
|
||||
date: 2020-10-06T08:50:45+00:00
|
||||
lastmod: 2020-10-06T08:50:45+00:00
|
||||
draft: false
|
||||
images: []
|
||||
avatar: "henk-verlinde.jpg"
|
||||
---
|
||||
|
||||
Creator of Hyas.
|
||||
|
||||
[@HenkVerlinde](https://twitter.com/henkverlinde)
|
||||
[@h-enk](https://github.com/h-enk)
|
||||
BIN
content/contributors/henk-verlinde/henk-verlinde.jpg
Normal file
BIN
content/contributors/henk-verlinde/henk-verlinde.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 200 KiB |
@ -2,6 +2,7 @@
|
||||
title: "Introduction"
|
||||
description: "Doks is a Hugo theme for building secure, fast, and SEO-ready documentation websites, which you can easily update and customize."
|
||||
lead: "Doks is a Hugo theme for building secure, fast, and SEO-ready documentation websites, which you can easily update and customize."
|
||||
summary: "Doks is a Hugo theme for building secure, fast, and SEO-ready documentation websites, which you can easily update and customize."
|
||||
date: 2020-10-06T08:48:57+00:00
|
||||
lastmod: 2020-10-06T08:48:57+00:00
|
||||
draft: false
|
||||
@ -1,8 +0,0 @@
|
||||
---
|
||||
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: []
|
||||
---
|
||||
@ -1,10 +0,0 @@
|
||||
---
|
||||
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" >}}
|
||||
@ -1,10 +0,0 @@
|
||||
---
|
||||
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.
|
||||
@ -1,12 +0,0 @@
|
||||
---
|
||||
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)
|
||||
@ -1,36 +0,0 @@
|
||||
---
|
||||
title: "Privacy Policy"
|
||||
description: "We do not use cookies and we do not collect any personal data."
|
||||
date: 2020-08-27T19:23:18+02:00
|
||||
lastmod: 2020-08-27T19:23:18+02:00
|
||||
draft: true
|
||||
images: []
|
||||
---
|
||||
|
||||
__TLDR__: We do not use cookies and we do not collect any personal data.
|
||||
|
||||
## Website visitors
|
||||
|
||||
- No personal information is collected.
|
||||
- No information is stored in the browser.
|
||||
- No information is shared with, sent to or sold to third-parties.
|
||||
- No information is shared with advertising companies.
|
||||
- No information is mined and harvested for personal and behavioral trends.
|
||||
- No information is monetized.
|
||||
|
||||
### Information we collect and what we use it for
|
||||
|
||||
We run [Plausible](https://plausible.io/) analytics on getdoks.org. The following information is collected:
|
||||
|
||||
- __Page URL__. We track the page URL of each page view on this website. We use this to understand which pages have been viewed and how many times a particular page has been viewed. For example: _https://getdoks.org/_.
|
||||
- __HTTP Referrer__. We use the referrer string to understand the number of visitors referred to this website from links on other sites. For example: _https://github.com/_.
|
||||
- __Browser__. We use this to understand what browsers people use when visiting this website. This is derived from the User-Agent HTTP header. The full User-Agent is discarded. For example: _Chrome_.
|
||||
- __Operating system__. We use this to understand what operating systems people use when visiting this website. We only use the brand of the operating system and don’t include the version number or any other details. This is derived from the User-Agent HTTP header. The full User-Agent is discarded. For example: _GNU/Linux_.
|
||||
- __Device type__. We use this to understand what devices people use when visiting this website. This is derived from window.innerWidth. The actual width of the browser in pixels is discarded. For example: _Desktop_.
|
||||
- __Visitor Country__. We look up the visitor’s country using the IP address. We do not track anything more granular than the country of origin and the IP address of the visitor is discarded. We never store IP addresses in our database or logs. For example: _Canada_.
|
||||
|
||||
## Contact us
|
||||
|
||||
[Contact us]({{< relref "contact/index.md" >}}) if you have any questions.
|
||||
|
||||
Effective Date: _27th August 2020_
|
||||
@ -1,10 +0,0 @@
|
||||
---
|
||||
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: []
|
||||
---
|
||||
|
||||
@ -1,10 +0,0 @@
|
||||
---
|
||||
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" >}}
|
||||
@ -1,9 +0,0 @@
|
||||
---
|
||||
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: []
|
||||
---
|
||||
@ -1,9 +0,0 @@
|
||||
---
|
||||
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: []
|
||||
---
|
||||
@ -1,50 +0,0 @@
|
||||
---
|
||||
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)
|
||||
@ -1,32 +0,0 @@
|
||||
---
|
||||
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>...]
|
||||
```
|
||||
@ -1,30 +0,0 @@
|
||||
---
|
||||
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
|
||||
```
|
||||
@ -1,9 +0,0 @@
|
||||
---
|
||||
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: []
|
||||
---
|
||||
@ -1,98 +0,0 @@
|
||||
---
|
||||
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
|
||||
```
|
||||
@ -1,58 +0,0 @@
|
||||
---
|
||||
title: "Introduction"
|
||||
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:48:57+00:00
|
||||
lastmod: 2020-10-06T08:48:57+00:00
|
||||
draft: false
|
||||
images: []
|
||||
menu:
|
||||
docs:
|
||||
parent: "prologue"
|
||||
weight: 100
|
||||
toc: true
|
||||
---
|
||||
|
||||
## Get started
|
||||
|
||||
There are two main ways to get started with Doks:
|
||||
|
||||
### Tutorial
|
||||
|
||||
{{< alert icon="👉" text="The Tutorial is intended for novice to intermediate users." />}}
|
||||
|
||||
Step-by-step instructions on how to start a new Doks project. [Tutorial →](https://getdoks.org/tutorial/introduction/)
|
||||
|
||||
### Quick Start
|
||||
|
||||
{{< alert icon="👉" text="The Quick Start is intended for intermediate to advanced users." />}}
|
||||
|
||||
One page summary of how to start a new Doks project. [Quick Start →]({{< relref "quick-start" >}})
|
||||
|
||||
## Go further
|
||||
|
||||
Recipes, Reference Guides, Extensions, and Showcase.
|
||||
|
||||
### Recipes
|
||||
|
||||
Get instructions on how to accomplish common tasks with Doks. [Recipes →](https://getdoks.org/docs/recipes/project-configuration/)
|
||||
|
||||
### Reference Guides
|
||||
|
||||
Learn how to customize Doks to fully make it your own. [Reference Guides →](https://getdoks.org/docs/reference-guides/security/)
|
||||
|
||||
### Extensions
|
||||
|
||||
Get instructions on how to add even more to Doks. [Extensions →](https://getdoks.org/docs/extensions/breadcrumb-navigation/)
|
||||
|
||||
### Showcase
|
||||
|
||||
See what others have build with Doks. [Showcase →](https://getdoks.org/showcase/electric-blocks/)
|
||||
|
||||
## Contributing
|
||||
|
||||
Find out how to contribute to Doks. [Contributing →](https://getdoks.org/docs/contributing/how-to-contribute/)
|
||||
|
||||
## Help
|
||||
|
||||
Get help on Doks. [Help →]({{< relref "how-to-update" >}})
|
||||
@ -1,69 +0,0 @@
|
||||
---
|
||||
title: "Quick Start"
|
||||
description: "One page summary of how to start a new Doks project."
|
||||
lead: "One page summary of how to start a new Doks project."
|
||||
date: 2020-11-16T13:59:39+01:00
|
||||
lastmod: 2020-11-16T13:59:39+01:00
|
||||
draft: false
|
||||
images: []
|
||||
menu:
|
||||
docs:
|
||||
parent: "prologue"
|
||||
weight: 110
|
||||
toc: true
|
||||
---
|
||||
|
||||
## Requirements
|
||||
|
||||
Doks uses npm to centralize dependency management, making it [easy to update]({{< relref "how-to-update" >}}) resources, build tooling, plugins, and build scripts:
|
||||
|
||||
- Download and install [Node.js](https://nodejs.org/) (it includes npm) for your platform.
|
||||
|
||||
## Start a new Doks project
|
||||
|
||||
Create a new site, change directories, install dependencies, and start development server.
|
||||
|
||||
### Create a new site
|
||||
|
||||
Doks is available as a child theme, and a starter theme:
|
||||
|
||||
- Use the Doks child theme, if you do __not__ plan to customize a lot, and/or need future Doks updates.
|
||||
- Use the Doks starter theme, if you plan to customize a lot, and/or do __not__ need future Doks updates.
|
||||
|
||||
Not quite sure? Use the Doks child theme.
|
||||
|
||||
#### Doks child theme
|
||||
|
||||
```bash
|
||||
git clone https://github.com/h-enk/doks-child-theme.git my-doks-site
|
||||
```
|
||||
|
||||
#### Doks starter theme
|
||||
|
||||
```bash
|
||||
git clone https://github.com/h-enk/doks.git my-doks-site
|
||||
```
|
||||
|
||||
### Change directories
|
||||
|
||||
```bash
|
||||
cd my-doks-site
|
||||
```
|
||||
|
||||
### Install dependencies
|
||||
|
||||
```bash
|
||||
npm install
|
||||
```
|
||||
|
||||
### Start development server
|
||||
|
||||
```bash
|
||||
npm run start
|
||||
```
|
||||
|
||||
Doks will start the Hugo development webserver accessible by default at `http://localhost:1313`. Saved changes will live reload in the browser.
|
||||
|
||||
## Other commands
|
||||
|
||||
Doks comes with commands for common tasks. [Commands →]({{< relref "commands" >}})
|
||||
@ -1,36 +0,0 @@
|
||||
---
|
||||
title: "Privacy Policy"
|
||||
description: "We do not use cookies and we do not collect any personal data."
|
||||
date: 2020-08-27T19:23:18+02:00
|
||||
lastmod: 2020-08-27T19:23:18+02:00
|
||||
draft: true
|
||||
images: []
|
||||
---
|
||||
|
||||
__TLDR__: We do not use cookies and we do not collect any personal data.
|
||||
|
||||
## Website visitors
|
||||
|
||||
- No personal information is collected.
|
||||
- No information is stored in the browser.
|
||||
- No information is shared with, sent to or sold to third-parties.
|
||||
- No information is shared with advertising companies.
|
||||
- No information is mined and harvested for personal and behavioral trends.
|
||||
- No information is monetized.
|
||||
|
||||
### Information we collect and what we use it for
|
||||
|
||||
We run [Plausible](https://plausible.io/) analytics on getdoks.org. The following information is collected:
|
||||
|
||||
- __Page URL__. We track the page URL of each page view on this website. We use this to understand which pages have been viewed and how many times a particular page has been viewed. For example: _https://getdoks.org/_.
|
||||
- __HTTP Referrer__. We use the referrer string to understand the number of visitors referred to this website from links on other sites. For example: _https://github.com/_.
|
||||
- __Browser__. We use this to understand what browsers people use when visiting this website. This is derived from the User-Agent HTTP header. The full User-Agent is discarded. For example: _Chrome_.
|
||||
- __Operating system__. We use this to understand what operating systems people use when visiting this website. We only use the brand of the operating system and don’t include the version number or any other details. This is derived from the User-Agent HTTP header. The full User-Agent is discarded. For example: _GNU/Linux_.
|
||||
- __Device type__. We use this to understand what devices people use when visiting this website. This is derived from window.innerWidth. The actual width of the browser in pixels is discarded. For example: _Desktop_.
|
||||
- __Visitor Country__. We look up the visitor’s country using the IP address. We do not track anything more granular than the country of origin and the IP address of the visitor is discarded. We never store IP addresses in our database or logs. For example: _Canada_.
|
||||
|
||||
## Contact us
|
||||
|
||||
[Contact us]({{< relref "contact/index.md" >}}) if you have any questions.
|
||||
|
||||
Effective Date: _27th August 2020_
|
||||
11
content/privacy.md
Normal file
11
content/privacy.md
Normal file
@ -0,0 +1,11 @@
|
||||
---
|
||||
title: "Privacy Policy"
|
||||
description: ""
|
||||
date: 2020-08-27T19:23:18+02:00
|
||||
lastmod: 2023-04-14T13:24:35+02:00
|
||||
draft: false
|
||||
images: []
|
||||
type: "legal"
|
||||
---
|
||||
|
||||
[Privacy Policy]
|
||||
11
content/terms.md
Normal file
11
content/terms.md
Normal file
@ -0,0 +1,11 @@
|
||||
---
|
||||
title: "Terms of Service"
|
||||
description: ""
|
||||
date: 2020-08-27T19:23:18+02:00
|
||||
lastmod: 2023-04-14T13:24:35+02:00
|
||||
draft: false
|
||||
images: []
|
||||
type: "legal"
|
||||
---
|
||||
|
||||
[Terms of Service]
|
||||
Reference in New Issue
Block a user