ux: update dark mode+
This commit is contained in:
Henk Verlinde
parent
e93a3075bc
commit
834afc3eec
|
|
@ -43,7 +43,7 @@ rel = "sitemap"
|
|||
[caches]
|
||||
[caches.getjson]
|
||||
dir = ":cacheDir/:project"
|
||||
maxAge = "10s"
|
||||
maxAge = "30m"
|
||||
|
||||
[taxonomies]
|
||||
contributor = "contributors"
|
||||
|
|
@ -51,8 +51,8 @@ rel = "sitemap"
|
|||
tag = "tags"
|
||||
|
||||
[permalinks]
|
||||
blog = "/blog/:title/"
|
||||
# docs = "/docs/1.0/:sections[1:]/:title/"
|
||||
blog = "/blog/:slug/"
|
||||
# docs = "/docs/1.0/:sections[1:]/:slug/"
|
||||
|
||||
[minify.tdewolff.html]
|
||||
keepWhitespace = false
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@ searchLimit = 5 # 0 (no limit, default) or natural number
|
|||
# Global alert
|
||||
alert = false # false (default) or true
|
||||
alertDismissable = true # true (default) or false
|
||||
alertText = '<a class="alert-link stretched-link fw-normal" href="/doks-version-10/">Doks version 1.0 just shipped!</a>'
|
||||
alertText = '<a class="alert-link stretched-link fw-normal" href="/blog/doks-1/">Doks version 1.0 just shipped!</a>'
|
||||
|
||||
# Bootstrap
|
||||
bootstrapJavascript = false # false (default) or true
|
||||
|
|
|
|||
|
|
@ -21,7 +21,7 @@ defaultMarkdownHandler = "goldmark"
|
|||
lineAnchors = ''
|
||||
lineNoStart = 1
|
||||
lineNos = false
|
||||
lineNumbersInTable = true
|
||||
lineNumbersInTable = false
|
||||
noClasses = false
|
||||
noHl = false
|
||||
style = 'github-dark'
|
||||
|
|
|
|||
|
|
@ -1,14 +1,14 @@
|
|||
[[docs]]
|
||||
name = "Prologue"
|
||||
weight = 10
|
||||
identifier = "prologue"
|
||||
url = "/docs/prologue/"
|
||||
# [[docs]]
|
||||
# name = "Prologue"
|
||||
# weight = 10
|
||||
# identifier = "prologue"
|
||||
# url = "/docs/prologue/"
|
||||
|
||||
[[docs]]
|
||||
name = "Help"
|
||||
weight = 60
|
||||
identifier = "help"
|
||||
url = "/docs/help/"
|
||||
# [[docs]]
|
||||
# name = "Help"
|
||||
# weight = 60
|
||||
# identifier = "help"
|
||||
# url = "/docs/help/"
|
||||
|
||||
# [[docs]]
|
||||
# name = "Lorem"
|
||||
|
|
@ -30,7 +30,7 @@
|
|||
|
||||
[[main]]
|
||||
name = "Docs"
|
||||
url = "/docs/prologue/introduction/"
|
||||
url = "/docs/start-here/getting-started/"
|
||||
# url = "/docs/1.0/prologue/introduction/"
|
||||
weight = 10
|
||||
|
||||
|
|
|
|||
|
|
@ -58,6 +58,14 @@
|
|||
source = "node_modules/mermaid"
|
||||
target = "assets/js/vendor/mermaid"
|
||||
|
||||
[[mounts]]
|
||||
source = "node_modules/@tabler/icons/icons"
|
||||
target = "assets/svgs/tabler-icons"
|
||||
|
||||
[[mounts]]
|
||||
source = "node_modules/@hyas/tabler-icons/layouts"
|
||||
target = "layouts"
|
||||
|
||||
[[mounts]]
|
||||
source = "archetypes"
|
||||
target = "archetypes"
|
||||
|
|
|
|||
|
|
@ -50,7 +50,7 @@ repoHost = "GitHub"
|
|||
docsRepo = "https://github.com/h-enk/doks"
|
||||
docsRepoBranch = "master"
|
||||
docsRepoSubPath = ""
|
||||
editPage = false
|
||||
editPage = true
|
||||
lastMod = false
|
||||
|
||||
# Images
|
||||
|
|
|
|||
|
|
@ -36,10 +36,14 @@ module.exports = {
|
|||
'lazyload',
|
||||
'blur-up',
|
||||
'figcaption',
|
||||
'dt',
|
||||
'dd',
|
||||
...whitelister([
|
||||
'./node_modules/@hyas/core/assets/scss/app.scss',
|
||||
'./node_modules/@hyas/doks-core/assets/scss/common/_global.scss',
|
||||
'./node_modules/@hyas/doks-core/assets/scss/components/_alerts.scss',
|
||||
'./node_modules/@hyas/doks-core/assets/scss/components/_buttons.scss',
|
||||
'./node_modules/@hyas/doks-core/assets/scss/components/_callouts.scss',
|
||||
'./node_modules/@hyas/doks-core/assets/scss/components/_code.scss',
|
||||
// './node_modules/@hyas/doks-core/assets/scss/components/_diagrams.scss',
|
||||
'./node_modules/@hyas/doks-core/assets/scss/components/_modals.scss',
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title : "Modern Documentation Theme"
|
||||
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."
|
||||
description: "Jumpstart your next documentation project with Doks. Build a customized, production-ready documentation website in no time."
|
||||
lead: "Jumpstart your next documentation project with Doks. Build a customized, production-ready documentation website in no time."
|
||||
date: 2020-10-06T08:47:36+00:00
|
||||
lastmod: 2020-10-06T08:47:36+00:00
|
||||
draft: false
|
||||
|
|
|
|||
|
|
@ -1,10 +1,15 @@
|
|||
---
|
||||
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
|
||||
title: "Blog"
|
||||
description: ""
|
||||
summary: ""
|
||||
date: 2023-05-17T08:59:31+02:00
|
||||
lastmod: 2023-05-17T08:59:31+02:00
|
||||
draft: false
|
||||
weight: 50
|
||||
images: []
|
||||
categories: []
|
||||
tags: []
|
||||
contributors: []
|
||||
pinned: false
|
||||
homepage: false
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1,182 +0,0 @@
|
|||
---
|
||||
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\\)
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
---
|
||||
title: "Doks 1.0"
|
||||
slug: "doks-1"
|
||||
description: ""
|
||||
summary: "Doks 1.0 is here! Doks is a Hyas theme for building customizable, production-ready documentation websites."
|
||||
date: 2023-05-17T09:15:34+02:00
|
||||
lastmod: 2023-05-17T09:15:34+02:00
|
||||
draft: false
|
||||
weight: 50
|
||||
images: []
|
||||
categories: []
|
||||
tags: []
|
||||
contributors: ["Henk Verlinde"]
|
||||
pinned: false
|
||||
homepage: false
|
||||
---
|
||||
|
||||
[..]
|
||||
|
|
@ -1,17 +0,0 @@
|
|||
---
|
||||
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."
|
||||
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: []
|
||||
tags: []
|
||||
contributors: ["Henk Verlinde"]
|
||||
pinned: false
|
||||
homepage: false
|
||||
---
|
||||
|
||||
Introducing Doks, a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default.
|
||||
|
|
@ -1,179 +0,0 @@
|
|||
---
|
||||
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" >}}
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
---
|
||||
title: "Cheat Sheets"
|
||||
description: ""
|
||||
lead: ""
|
||||
date: 2023-05-12T16:35:16+02:00
|
||||
lastmod: 2023-05-12T16:35:16+02:00
|
||||
draft: false
|
||||
images: []
|
||||
menu:
|
||||
docs:
|
||||
parent: ""
|
||||
identifier: "cheat-sheets-6bc84c337d53d392074322ff6492c34c"
|
||||
weight: 200
|
||||
toc: true
|
||||
---
|
||||
|
|
@ -1,20 +1,25 @@
|
|||
---
|
||||
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
|
||||
description: "A quick reference to the Markdown basic syntax."
|
||||
summary: "A quick reference to the Markdown basic syntax."
|
||||
date: 2023-05-12T16:35:44+02:00
|
||||
lastmod: 2023-05-12T16:35:44+02:00
|
||||
draft: false
|
||||
weight: 50
|
||||
images: ["markdown-guide.jpg"]
|
||||
categories: []
|
||||
tags: []
|
||||
contributors: ["Henk Verlinde"]
|
||||
pinned: false
|
||||
homepage: false
|
||||
images: []
|
||||
menu:
|
||||
docs:
|
||||
parent: ""
|
||||
identifier: "markdown-basic-syntax-08aeef306d3f46c4e40c17b559b715c1"
|
||||
weight: 210
|
||||
toc: true
|
||||
---
|
||||
|
||||
If you need more information about any of these elements, refer to the reference guide for [basic syntax](https://www.markdownguide.org/basic-syntax).
|
||||
A quick reference to the Markdown basic syntax.
|
||||
{ .lead }
|
||||
|
||||
{{< callout icon="info-circle" >}}
|
||||
Refer to the [basic syntax](https://www.markdownguide.org/basic-syntax) reference guide for more information.
|
||||
{{< /callout >}}
|
||||
|
||||
## Heading
|
||||
|
||||
|
|
@ -24,10 +29,6 @@ If you need more information about any of these elements, refer to the reference
|
|||
### H3
|
||||
```
|
||||
|
||||
# H1
|
||||
## H2
|
||||
### H3
|
||||
|
||||
## Bold
|
||||
|
||||
```md
|
||||
|
Before Width: | Height: | Size: 79 KiB After Width: | Height: | Size: 79 KiB |
|
|
@ -1,20 +1,25 @@
|
|||
---
|
||||
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
|
||||
description: "A quick reference to the Markdown extended syntax."
|
||||
summary: "A quick reference to the Markdown extended syntax."
|
||||
date: 2023-05-12T16:35:56+02:00
|
||||
lastmod: 2023-05-12T16:35:56+02:00
|
||||
draft: false
|
||||
weight: 50
|
||||
images: []
|
||||
categories: []
|
||||
tags: []
|
||||
contributors: ["Henk Verlinde"]
|
||||
pinned: false
|
||||
homepage: false
|
||||
menu:
|
||||
docs:
|
||||
parent: ""
|
||||
identifier: "markdown-extended-syntax-f467db1a842b35cffcbd916e2e6a56bc"
|
||||
weight: 220
|
||||
toc: true
|
||||
---
|
||||
|
||||
If you need more information about any of these elements, refer to the reference guide for [extended syntax](https://www.markdownguide.org/extended-syntax).
|
||||
A quick reference to the Markdown extended syntax.
|
||||
{ .lead }
|
||||
|
||||
{{< callout icon="info-circle" >}}
|
||||
Refer to the [extended syntax](https://www.markdownguide.org/extended-syntax) reference guide for more information.
|
||||
{{< /callout >}}
|
||||
|
||||
## Table
|
||||
|
||||
|
|
@ -23,14 +28,12 @@ If you need more information about any of these elements, refer to the reference
|
|||
| ----------- | ----------- |
|
||||
| Header | Title |
|
||||
| Paragraph | Text |
|
||||
{.table .table-striped}
|
||||
```
|
||||
|
||||
| Syntax | Description |
|
||||
| ----------- | ----------- |
|
||||
| Header | Title |
|
||||
| Paragraph | Text |
|
||||
{.table .table-striped}
|
||||
|
||||
## Fenced Code Block
|
||||
|
||||
|
|
@ -110,14 +113,22 @@ term
|
|||
|
||||
## Emoji
|
||||
|
||||
{{< callout icon="info-circle" >}}
|
||||
Copy the emoji shortcode from [Emoji Cheat Sheet](https://www.webfx.com/tools/emoji-cheat-sheet/) by clicking on the emoji.
|
||||
{{< /callout >}}
|
||||
|
||||
<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))
|
||||
## Unsupported elements
|
||||
|
||||
## Highlight
|
||||
{{< callout icon="info-circle" >}}
|
||||
Hugo does not [support](https://www.markdownguide.org/tools/hugo/#hugo-markdown-support) the highlight, subscript, and superscript elements. Use the HTML element itself instead.
|
||||
{{< /callout >}}
|
||||
|
||||
### Highlight
|
||||
|
||||
```md
|
||||
I need to highlight these <mark>very important words</mark>.
|
||||
|
|
@ -125,9 +136,7 @@ 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
|
||||
### Subscript
|
||||
|
||||
```md
|
||||
H<sub>2</sub>O
|
||||
|
|
@ -135,14 +144,10 @@ 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
|
||||
### Superscript
|
||||
|
||||
```md
|
||||
X<sup>2</sup>
|
||||
```
|
||||
|
||||
X<sup>2</sup>
|
||||
|
||||
(See also [Hugo Markdown Support](https://www.markdownguide.org/tools/hugo/#hugo-markdown-support))
|
||||
|
|
@ -0,0 +1,273 @@
|
|||
---
|
||||
title: "Shortcodes"
|
||||
description: "A quick reference to the Doks shortcodes."
|
||||
summary: "A quick reference to the Doks shortcodes."
|
||||
date: 2023-05-12T16:36:04+02:00
|
||||
lastmod: 2023-05-12T16:36:04+02:00
|
||||
draft: false
|
||||
images: []
|
||||
menu:
|
||||
docs:
|
||||
parent: ""
|
||||
identifier: "shortcodes-b20379ce4f24fa487bf2dd1a8367a4f1"
|
||||
weight: 230
|
||||
toc: true
|
||||
---
|
||||
|
||||
A quick reference to the Doks shortcodes.
|
||||
{.lead}
|
||||
|
||||
{{< callout icon="info-circle" >}}
|
||||
Refer to [components](https://getdoks.org/docs/components/) for more information.
|
||||
{{< /callout >}}
|
||||
|
||||
## SVG
|
||||
|
||||
Add an [SVG](https://developer.mozilla.org/en-US/docs/Web/SVG) from the assets directory, page resources, or Tabler icons.
|
||||
|
||||
{{< callout icon="info-circle" >}}
|
||||
The [SVG](https://developer.mozilla.org/en-US/docs/Web/SVG) gets embedded into the pages' HTML.
|
||||
{{< /callout >}}
|
||||
|
||||
### Assets directory
|
||||
|
||||
Add e.g. a logo from the `assets` directory:
|
||||
|
||||
```md
|
||||
{{</* svg icon="svgs/logos/logo-netlify-small-monochrome-lightmode.svg" width="192px" height="79px" class="icon-custom netlify-logo" */>}}
|
||||
```
|
||||
|
||||
{{< svg icon="svgs/logos/logo-netlify-small-monochrome-lightmode.svg" width="192px" height="79px" class="icon-custom netlify-logo" >}}
|
||||
|
||||
### Page resources
|
||||
|
||||
{{< callout icon="info-circle" >}}
|
||||
Refer to [page resources](https://gohugo.io/content-management/page-resources/) and [page bundles](https://gohugo.io/content-management/page-bundles/) for more information.
|
||||
{{< /callout >}}
|
||||
|
||||
Add e.g a monogram
|
||||
:
|
||||
|
||||
```md
|
||||
{{</* svg icon="logo-netlify-monogram-monochrome-lightmode.svg" width="64px" height="57px" class="icon-custom netlify-monogram" */>}}
|
||||
```
|
||||
|
||||
{{< svg icon="logo-netlify-monogram-monochrome-lightmode.svg" width="64px" height="57px" class="icon-custom netlify-monogram" >}}
|
||||
|
||||
### Tabler icons
|
||||
|
||||
{{< callout icon="copy" >}}
|
||||
Copy the icon name from [Tabler Icons](https://tabler-icons.io/) by clicking on it's name.
|
||||
{{< /callout >}}
|
||||
|
||||
Add a Tabler icon:
|
||||
|
||||
```md
|
||||
{{</* svg "rubber-stamp" */>}}
|
||||
```
|
||||
|
||||
{{< svg "rubber-stamp" >}}
|
||||
|
||||
Specify [SVG attributes](https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute), for example:
|
||||
|
||||
```md
|
||||
{{</* svg icon="rubber-stamp" stroke-width="1" height="3rem" width="3rem" class="icon-custom" */>}}
|
||||
```
|
||||
|
||||
{{< svg icon="rubber-stamp" stroke-width="1" height="3rem" width="3rem" class="icon-custom" >}}
|
||||
|
||||
## Callouts
|
||||
|
||||
```md
|
||||
{{</* callout */>}} This is a default callout. Example text to show it in action. {{</* /callout */>}}
|
||||
```
|
||||
|
||||
```md
|
||||
{{</* callout info */>}} This is an info callout. Example text to show it in action. {{</* /callout */>}}
|
||||
```
|
||||
|
||||
```md
|
||||
{{</* callout warning */>}} This is a warning callout. Example text to show it in action. {{</* /callout */>}}
|
||||
```
|
||||
|
||||
```md
|
||||
{{</* callout danger */>}} This is a danger callout. Example text to show it in action. {{</* /callout */>}}
|
||||
```
|
||||
|
||||
{{< callout >}} This is a default callout. Example text to show it in action. {{< /callout >}}
|
||||
|
||||
{{< callout info >}} This is an info callout. Example text to show it in action. {{< /callout >}}
|
||||
|
||||
{{< callout warning >}} This is a warning callout. Example text to show it in action. {{< /callout >}}
|
||||
|
||||
{{< callout danger >}} This is a danger callout. Example text to show it in action. {{< /callout >}}
|
||||
|
||||
### Tabler icons
|
||||
|
||||
{{< callout icon="copy" >}}
|
||||
Copy the icon name from [Tabler Icons](https://tabler-icons.io/) by clicking on it's name.
|
||||
{{< /callout >}}
|
||||
|
||||
```md
|
||||
{{</* callout context="info" icon="info-circle" */>}} This is an **info** callout. Example text to show it in action. {{</* /callout */>}}
|
||||
```
|
||||
|
||||
{{< callout context="info" icon="info-circle" >}} This is an **info** callout. Example text to show it in action.{{< /callout >}}
|
||||
|
||||
```md
|
||||
{{</* callout context="info" icon="info-circle" */>}}
|
||||
Aww yeah, you successfully read this important alert message. This example text is going to run a bit longer so that you can see how spacing within a callout works with this kind of content.
|
||||
{{</* /callout */>}}
|
||||
```
|
||||
|
||||
{{< callout context="info" icon="info-circle" >}}
|
||||
Aww yeah, you successfully read this important alert message. This example text is going to run a bit longer so that you can see how spacing within a callout works with this kind of content.
|
||||
{{< /callout >}}
|
||||
|
||||
### Title
|
||||
|
||||
```md
|
||||
{{</* callout context="info" title="Callout title" */>}} This is an info callout. Example text to show it in action. {{</* /callout */>}}
|
||||
```
|
||||
|
||||
{{< callout context="info" title="Callout title" >}} This is an info callout. Example text to show it in action. {{< /callout >}}
|
||||
|
||||
```md
|
||||
{{</* callout context="info" title="Callout title" icon="info-circle" */>}} This is an info callout. Example text to show it in action. {{</* /callout */>}}
|
||||
```
|
||||
|
||||
{{< callout context="info" title="Callout title" icon="info-circle" >}} This is an info callout. Example text to show it in action. {{< /callout >}}
|
||||
|
||||
### Inline code
|
||||
|
||||
{{< callout context="light" icon="info-circle" >}}
|
||||
You can change the commands in the scripts section of `./package.json`.
|
||||
{{< /callout >}}
|
||||
|
||||
{{< callout context="warning" icon="info-circle" >}}
|
||||
You can change the commands in the scripts section of `./package.json`.
|
||||
{{< /callout >}}
|
||||
|
||||
{{< callout context="danger" icon="info-circle" >}}
|
||||
You can change the commands in the scripts section of `./package.json`.
|
||||
{{< /callout >}}
|
||||
|
||||
{{< callout context="info" icon="info-circle" >}}
|
||||
You can change the commands in the scripts section of `./package.json`.
|
||||
{{< /callout >}}
|
||||
|
||||
## 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 >}}
|
||||
|
||||
### Start in open state
|
||||
|
||||
```md
|
||||
{{</* details "Start in open state" open */>}}
|
||||
This Boolean attribute indicates whether the details — that is, the contents of the <details> element — are currently visible. The details are shown when this attribute exists, or hidden when this attribute is absent. By default this attribute is absent which means the details are not visible.
|
||||
{{</* /details */>}}
|
||||
```
|
||||
|
||||
{{< details "Start in open state" open >}}
|
||||
This Boolean attribute indicates whether the details — that is, the contents of the `<details>` element — are currently visible. The details are shown when this attribute exists, or hidden when this attribute is absent. By default this attribute is absent which means the details are not visible.
|
||||
{{< /details >}}
|
||||
|
||||
## Tabs
|
||||
|
||||
````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 */>}}
|
||||
````
|
||||
|
||||
{{< callout icon="info-circle" >}}
|
||||
The selected tab is remembered in and across pages.
|
||||
{{< /callout >}}
|
||||
|
||||
Run the following command in your terminal to start our handy install wizard, `create-hyas`.
|
||||
|
||||
{{< 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.
|
||||
|
||||
{{< 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" >}}
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
<svg width="128" height="113" viewBox="0 0 128 113" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<g clip-path="url(#clip0_236_179)">
|
||||
<path d="M34.593 94.2052H33.3844L27.3514 88.1722V86.9637L36.5743 77.7409H42.9639L43.8158 78.5928V84.9824L34.593 94.2052Z" fill="#181A1C"/>
|
||||
<path d="M27.3514 25.9703V24.7617L33.3844 18.7287H34.593L43.8158 27.9515V34.3411L42.9639 35.1931H36.5743L27.3514 25.9703Z" fill="#181A1C"/>
|
||||
<path d="M80.4594 74.759H71.6824L70.9493 74.026V53.4802C70.9493 49.8248 69.5129 46.9915 65.1046 46.8925C62.836 46.833 60.2405 46.8925 57.4668 47.0014L57.0507 47.4274V74.0161L56.3176 74.7491H47.5406L46.8075 74.0161V38.9179L47.5406 38.1848H67.2939C74.9713 38.1848 81.1925 44.406 81.1925 52.0834V74.026L80.4594 74.759Z" fill="#181A1C"/>
|
||||
<path d="M35.8412 61.6034H0.73307L0 60.8703V52.0735L0.73307 51.3404H35.8412L36.5743 52.0735V60.8703L35.8412 61.6034Z" fill="#181A1C"/>
|
||||
<path d="M127.277 61.6034H92.1687L91.4356 60.8703V52.0735L92.1687 51.3404H127.277L128.01 52.0735V60.8703L127.277 61.6034Z" fill="#181A1C"/>
|
||||
<path d="M58.9428 27.2185V0.887367L59.6759 0.154297H68.4727L69.2058 0.887367V27.2185L68.4727 27.9515H59.6759L58.9428 27.2185Z" fill="#181A1C"/>
|
||||
<path d="M58.9428 112.056V85.7254L59.6759 84.9923H68.4727L69.2058 85.7254V112.056L68.4727 112.79H59.6759L58.9428 112.056Z" fill="#181A1C"/>
|
||||
</g>
|
||||
<defs>
|
||||
<clipPath id="clip0_236_179">
|
||||
<rect width="128" height="112.635" fill="white" transform="translate(0 0.154297)"/>
|
||||
</clipPath>
|
||||
</defs>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 1.4 KiB |
|
|
@ -1,10 +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: []
|
||||
weight: 600
|
||||
---
|
||||
|
|
@ -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,10 +0,0 @@
|
|||
---
|
||||
title: "Lorem"
|
||||
description: ""
|
||||
lead: ""
|
||||
date: 2022-01-18T19:58:14+01:00
|
||||
lastmod: 2022-01-18T19:58:14+01:00
|
||||
draft: true
|
||||
images: []
|
||||
toc: true
|
||||
---
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
---
|
||||
title: "Ipsum"
|
||||
description: ""
|
||||
lead: ""
|
||||
date: 2022-01-18T20:00:32+01:00
|
||||
lastmod: 2022-01-18T20:00:32+01:00
|
||||
draft: false
|
||||
images: []
|
||||
menu:
|
||||
docs:
|
||||
parent: "lorem"
|
||||
identifier: "ipsum"
|
||||
weight: 999
|
||||
toc: true
|
||||
---
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
---
|
||||
title: "Amet"
|
||||
description: ""
|
||||
lead: ""
|
||||
date: 2022-01-18T20:07:56+01:00
|
||||
lastmod: 2022-01-18T20:07:56+01:00
|
||||
draft: false
|
||||
images: []
|
||||
menu:
|
||||
docs:
|
||||
parent: "ipsum"
|
||||
identifier: "amet"
|
||||
weight: 999
|
||||
toc: true
|
||||
---
|
||||
|
|
@ -1,14 +0,0 @@
|
|||
---
|
||||
title: "Consectetur"
|
||||
description: ""
|
||||
lead: ""
|
||||
date: 2022-01-18T20:17:32+01:00
|
||||
lastmod: 2022-01-18T20:17:32+01:00
|
||||
draft: false
|
||||
images: []
|
||||
menu:
|
||||
docs:
|
||||
parent: "amet"
|
||||
weight: 730
|
||||
toc: true
|
||||
---
|
||||
|
|
@ -1,14 +0,0 @@
|
|||
---
|
||||
title: "Dolor"
|
||||
description: ""
|
||||
lead: ""
|
||||
date: 2022-01-18T20:01:45+01:00
|
||||
lastmod: 2022-01-18T20:01:45+01:00
|
||||
draft: false
|
||||
images: []
|
||||
menu:
|
||||
docs:
|
||||
parent: "ipsum"
|
||||
weight: 700
|
||||
toc: true
|
||||
---
|
||||
|
|
@ -1,14 +0,0 @@
|
|||
---
|
||||
title: "Sit"
|
||||
description: ""
|
||||
lead: ""
|
||||
date: 2022-01-18T20:05:19+01:00
|
||||
lastmod: 2022-01-18T20:05:19+01:00
|
||||
draft: false
|
||||
images: []
|
||||
menu:
|
||||
docs:
|
||||
parent: "ipsum"
|
||||
weight: 710
|
||||
toc: true
|
||||
---
|
||||
|
|
@ -1,10 +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: []
|
||||
weight: 100
|
||||
---
|
||||
|
|
@ -1,112 +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/).
|
||||
|
||||
### Docs based tree
|
||||
|
||||
Create a docs based tree — with a single command:
|
||||
|
||||
```bash
|
||||
npm run create -- --kind docs [section]
|
||||
```
|
||||
|
||||
For example, create a docs based tree named guides:
|
||||
|
||||
```bash
|
||||
npm run create -- --kind docs guides
|
||||
```
|
||||
|
||||
## 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,59 +0,0 @@
|
|||
---
|
||||
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
|
||||
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,79 +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
|
||||
|
||||
- [Git](https://git-scm.com/) — latest source release
|
||||
- [Node.js](https://nodejs.org/) — latest LTS version or newer
|
||||
|
||||
{{< details "Why Node.js?" >}}
|
||||
Doks uses npm (included with Node.js) to centralize dependency management, making it [easy to update]({{< relref "how-to-update" >}}) resources, build tooling, plugins, and build scripts.
|
||||
{{< /details >}}
|
||||
|
||||
## 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.
|
||||
|
||||
#### Child theme
|
||||
|
||||
- Intended for novice to intermediate users
|
||||
- Intended for minor customizations
|
||||
- [Easily update npm packages]({{< relref "how-to-update" >}}) — __including__ [Doks](https://www.npmjs.com/package/@hyas/doks)
|
||||
|
||||
```bash
|
||||
git clone https://github.com/h-enk/doks-child-theme.git my-doks-site
|
||||
```
|
||||
|
||||
#### Starter theme
|
||||
|
||||
- Intended for intermediate to advanced users
|
||||
- Intended for major customizations
|
||||
- [Easily update npm packages]({{< relref "how-to-update" >}})
|
||||
|
||||
```bash
|
||||
git clone https://github.com/h-enk/doks.git my-doks-site
|
||||
```
|
||||
|
||||
{{< details "Help me choose" >}}
|
||||
Not sure which one is for you? Pick the child theme.
|
||||
{{< /details >}}
|
||||
|
||||
### 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" >}})
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
---
|
||||
title: "Start Here"
|
||||
description: ""
|
||||
summary: ""
|
||||
date: 2023-05-15T12:14:40+02:00
|
||||
lastmod: 2023-05-15T12:14:40+02:00
|
||||
draft: false
|
||||
images: []
|
||||
menu:
|
||||
docs:
|
||||
parent: ""
|
||||
identifier: "start-here-bab8f7a5fc9e56a9c0f2ac570ed20b51"
|
||||
weight: 100
|
||||
toc: true
|
||||
---
|
||||
|
|
@ -0,0 +1,70 @@
|
|||
---
|
||||
title: "Getting Started"
|
||||
description: ""
|
||||
summary: ""
|
||||
date: 2023-05-15T12:16:32+02:00
|
||||
lastmod: 2023-05-15T12:16:32+02:00
|
||||
draft: false
|
||||
images: []
|
||||
menu:
|
||||
docs:
|
||||
parent: ""
|
||||
identifier: "getting-started-6773eb7de506682cac098bb1a83e1cdf"
|
||||
weight: 110
|
||||
toc: true
|
||||
---
|
||||
|
||||
## What is Doks?
|
||||
|
||||
Doks is a [Hyas](https://gethyas.com/) theme for building customizable, production-ready documentation websites.
|
||||
|
||||
## Key Features
|
||||
|
||||
- **Hugo powered:** Fast and flexible framework for building websites.
|
||||
- **Project dependencies**: Install and update dependencies easier with [npm](https://www.npmjs.com/).
|
||||
- **Production-ready**: Optimized for speed, SEO, and security.
|
||||
- **Customizable:** Build the website you want with settings and integrations.
|
||||
- **Development tools:** Check styles, scripts, and markdown for errors.
|
||||
- **Deploy anywhere:** Deployment guides to different deployment services.
|
||||
|
||||
Check out our detailed [Why Doks](https://getdoks.org/concepts/why-doks/) breakdown to learn more about what makes Doks special. :sparkles:
|
||||
|
||||
## Learn Doks
|
||||
|
||||
See examples of some of the key concepts and patterns of a Doks site!
|
||||
|
||||
- [Add your first page](https://getdoks.org/) to your site.
|
||||
- Read more about Doks' [project structure](https://getdoks.org/).
|
||||
- Learn about Doks' [project configuration](https://getdoks.org/).
|
||||
{ .list-books }
|
||||
|
||||
## Extend Doks
|
||||
|
||||
- Customize your site with official and community [plugins](https://getdoks.org/integrations/).
|
||||
- Deploy your site where you want with our [deployment guides](https://getdoks.org/guides/deploy/).
|
||||
- Get inspired by visiting our site [showcase](https://getdoks.org/showcase/).
|
||||
{ .list-toolbox }
|
||||
|
||||
… see our guide to using [plugins](https://getdoks.org/).
|
||||
|
||||
## Join our Community
|
||||
|
||||
Join us on [Doks Discussions](https://github.com/h-enk/doks/discussions) to share with and get help from an active, friendly community!
|
||||
|
||||
- Say hi in [Introductions](https://github.com/h-enk/doks/discussions/categories/introductions)!
|
||||
- Ask our Support Squad a question in [Q&A](https://github.com/h-enk/doks/discussions/categories/q-a)!
|
||||
- Share what you’ve been working on in [Show and tell](https://github.com/h-enk/doks/discussions/categories/show-and-tell)!
|
||||
{.list-speech-balloon}
|
||||
|
||||
## What's New?
|
||||
|
||||
- [Doks Blog](https://getdoks.org/blog/)
|
||||
- [Doks changelog](https://github.com/h-enk/doks/blob/master/CHANGELOG.md)
|
||||
|
||||
## Contribute
|
||||
|
||||
Doks is brought to you by all these helpful people. [Join us on GitHub!](https://github.com/h-enk/doks)
|
||||
|
||||
{{< contributors >}}
|
||||
|
||||
{{< contributors "h-enk/getdoks.org" >}}
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"name": "doks-recommended",
|
||||
"version": "1.0.0-alpha1",
|
||||
"version": "1.0.0-alpha2",
|
||||
"description": "Doks theme with recommended plugins",
|
||||
"main": "index.js",
|
||||
"scripts": {
|
||||
|
|
@ -42,10 +42,10 @@
|
|||
},
|
||||
"homepage": "https://github.com/hyas/doks#readme",
|
||||
"devDependencies": {
|
||||
"@hyas/doks-core": "^0.1.6",
|
||||
"@hyas/doks-core": "^0.1.7",
|
||||
"@hyas/images": "^0.3.2",
|
||||
"@hyas/seo": "^0.1.3",
|
||||
"auto-changelog": "^2.4.0",
|
||||
"gethyas": "^2.0.4"
|
||||
"gethyas": "^2.0.5"
|
||||
}
|
||||
}
|
||||
|
|
|
|||
2251
pnpm-lock.yaml
2251
pnpm-lock.yaml
File diff suppressed because it is too large
Load Diff
Loading…
Reference in New Issue