feat: update for doks v1.0.0-alpha.1
This commit is contained in:
Henk Verlinde
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))
|
||||
17
content/blog/say-hello-to-doks/index.md
Normal file
17
content/blog/say-hello-to-doks/index.md
Normal file
@ -0,0 +1,17 @@
|
||||
---
|
||||
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.
|
||||
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" >}}
|
||||
Reference in New Issue
Block a user