feat: update for Doks 1.0
This commit is contained in:
Henk Verlinde
parent
7fbc17eb0c
commit
dfd5ee1d0d
|
|
@ -5,4 +5,4 @@
|
|||
yarn-error.log
|
||||
node_modules
|
||||
public
|
||||
# resources
|
||||
resources
|
||||
|
|
|
|||
23
README.md
23
README.md
|
|
@ -1,31 +1,12 @@
|
|||
|
||||
# Doks
|
||||
|
||||
<p align="center">
|
||||
<br/>
|
||||
<a href="https://getdoks.org/">Doks</a> is a fast, flexible, and easy-to-use documentation theme built on <a href="https://gethyas.com/">Hyas</a> —
|
||||
<br/>
|
||||
the all-in-one Hugo-npm framework.
|
||||
<br/><br/>
|
||||
</p>
|
||||
Doks is a documentation theme for [Hyas](https://gethyas.com/).
|
||||
|
||||
## Demo
|
||||
|
||||
- [doks.netlify.app](https://doks.netlify.app/)
|
||||
|
||||
## 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 scripts, styles, 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. ✨
|
||||
|
||||
## Requirements
|
||||
|
||||
- [Node.js](https://nodejs.org/) — `v16.12.0` or higher
|
||||
|
||||
## Install
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
title = "Doks"
|
||||
title = "My Docs"
|
||||
baseurl = "/"
|
||||
canonifyURLs = false
|
||||
disableAliases = true
|
||||
|
|
@ -58,6 +58,7 @@ rel = "sitemap"
|
|||
|
||||
[permalinks]
|
||||
blog = "/blog/:slug/"
|
||||
docs = "/docs/:sections[1:]/:slug/"
|
||||
# docs = "/docs/1.0/:sections[1:]/:slug/"
|
||||
|
||||
[minify.tdewolff.html]
|
||||
|
|
@ -78,8 +79,8 @@ rel = "sitemap"
|
|||
weight = 10
|
||||
|
||||
[imaging]
|
||||
anchor = 'Smart'
|
||||
bgColor = '#fff'
|
||||
hint = 'photo'
|
||||
quality = 90
|
||||
resampleFilter = 'Lanczos'
|
||||
anchor = "Smart"
|
||||
bgColor = "#ffffff"
|
||||
hint = "photo"
|
||||
quality = 75
|
||||
resampleFilter = "Box"
|
||||
|
|
|
|||
|
|
@ -13,7 +13,8 @@ navBarButtonText = "Get started"
|
|||
|
||||
# FlexSearch
|
||||
flexSearch = true # true (default) or false
|
||||
indexPages = [] # [] (all regular pages, default) or list of sections (e.g. ["blog", "guides"])
|
||||
searchExclKinds = [] # list of page kinds to exclude from search indexing (e.g. ["home", "taxonomy", "term"] )
|
||||
searchExclTypes = [] # list of content types to exclude from search indexing (e.g. ["blog", "docs", "legal", "contributors", "categories"])
|
||||
showSearch = [] # [] (all pages, default) or homepage (optionally) and list of sections (e.g. ["homepage", "blog", "guides"])
|
||||
|
||||
## Search results
|
||||
|
|
@ -24,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="/blog/doks-1/">Doks version 1.0 just shipped!</a>'
|
||||
alertText = '<a class="alert-link stretched-link fw-normal" href="/blog/example-post/">Doks version 1.0 just shipped!</a>'
|
||||
|
||||
# Bootstrap
|
||||
bootstrapJavascript = false # false (default) or true
|
||||
|
|
@ -38,13 +39,14 @@ scrollSpy = true # true (default) or false
|
|||
|
||||
# Multilingual
|
||||
multilingualMode = false # false (default) or true
|
||||
showMissingLanguages = true # whether or not to show untranslated languages in the language menu; true (default) or false
|
||||
|
||||
# Versioning
|
||||
docsVersioning = false # false (default) or true
|
||||
docsVersion = "1.0"
|
||||
|
||||
# UX
|
||||
headerBar = true # true (default) or false
|
||||
headerBar = false # false (default) or true
|
||||
backgroundDots = true # true (default) or false
|
||||
|
||||
# Homepage
|
||||
|
|
@ -54,10 +56,10 @@ sectionFooter = false # false (default) or true
|
|||
relatedPosts = false # false (default) or true
|
||||
|
||||
# Footer
|
||||
footer = "Powered by <a class=\"text-muted\" href=\"https://www.netlify.com/\">Netlify</a>, <a class=\"text-muted\" href=\"https://gohugo.io/\">Hugo</a>, and <a class=\"text-muted\" href=\"https://getdoks.org/\">Doks</a>"
|
||||
footer = "Brought to you by <a class=\"text-muted\" href=\"https://gethyas.com/\">Hyas</a>"
|
||||
|
||||
# kaTex
|
||||
kaTex = false
|
||||
# KaTex
|
||||
katex = false
|
||||
|
||||
# Repository
|
||||
editPage = false # false (default) or true
|
||||
|
|
|
|||
|
|
@ -30,53 +30,21 @@
|
|||
|
||||
[[main]]
|
||||
name = "Docs"
|
||||
url = "/docs/start-here/getting-started/"
|
||||
url = "/docs/guides/example-guide/"
|
||||
# url = "/docs/1.0/prologue/introduction/"
|
||||
weight = 10
|
||||
|
||||
[[main]]
|
||||
name = "Resources"
|
||||
weight = 20
|
||||
identifier = "resources"
|
||||
url = "/"
|
||||
|
||||
[[main]]
|
||||
name = "Integrations"
|
||||
weight = 21
|
||||
identifier = "integrations"
|
||||
url = "https://deploy-preview-256--gethyas.netlify.app/plugins/"
|
||||
parent = "resources"
|
||||
|
||||
[[main]]
|
||||
name = "Tutorials"
|
||||
weight = 21
|
||||
identifier = "tutorials"
|
||||
url = "https://getdoks.org/docs/tutorial/introduction/"
|
||||
parent = "resources"
|
||||
|
||||
[[main]]
|
||||
name = "Discussions"
|
||||
weight = 23
|
||||
identifier = "discussions"
|
||||
url = "https://github.com/h-enk/doks/discussions"
|
||||
parent = "resources"
|
||||
|
||||
[[main]]
|
||||
name = "Blog"
|
||||
url = "/blog/"
|
||||
weight = 30
|
||||
|
||||
[[main]]
|
||||
name = "About"
|
||||
url = "/about/"
|
||||
weight = 40
|
||||
|
||||
# [[social]]
|
||||
# name = "Twitter"
|
||||
# pre = '<svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-brand-twitter" width="24" height="24" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M22 4.01c-1 .49 -1.98 .689 -3 .99c-1.121 -1.265 -2.783 -1.335 -4.38 -.737s-2.643 2.06 -2.62 3.737v1c-3.245 .083 -6.135 -1.395 -8 -4c0 0 -4.182 7.433 4 11c-1.872 1.247 -3.739 2.088 -6 2c3.308 1.803 6.913 2.423 10.034 1.517c3.58 -1.04 6.522 -3.723 7.651 -7.742a13.84 13.84 0 0 0 .497 -3.753c0 -.249 1.51 -2.772 1.818 -4.013z"></path></svg>'
|
||||
# pre = '<svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-brand-x" width="24" height="24" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M4 4l11.733 16h4.267l-11.733 -16z"></path><path d="M4 20l6.768 -6.768m2.46 -2.46l6.772 -6.772"></path></svg>'
|
||||
# url = "https://twitter.com/getdoks"
|
||||
# weight = 10
|
||||
|
||||
#
|
||||
# [[social]]
|
||||
# name = "Discord"
|
||||
# pre = '<svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-brand-discord" width="24" height="24" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M8 12a1 1 0 1 0 2 0a1 1 0 0 0 -2 0"></path><path d="M14 12a1 1 0 1 0 2 0a1 1 0 0 0 -2 0"></path><path d="M8.5 17c0 1 -1.356 3 -1.832 3c-1.429 0 -2.698 -1.667 -3.333 -3c-.635 -1.667 -.476 -5.833 1.428 -11.5c1.388 -1.015 2.782 -1.34 4.237 -1.5l.975 1.923a11.913 11.913 0 0 1 4.053 0l.972 -1.923c1.5 .16 3.043 .485 4.5 1.5c2 5.667 2.167 9.833 1.5 11.5c-.667 1.333 -2 3 -3.5 3c-.5 0 -2 -2 -2 -3"></path><path d="M7 16.5c3.5 1 6.5 1 10 0"></path></svg>'
|
||||
|
|
@ -86,16 +54,16 @@
|
|||
[[social]]
|
||||
name = "GitHub"
|
||||
pre = '<svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-brand-github" width="24" height="24" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M9 19c-4.3 1.4 -4.3 -2.5 -6 -3m12 5v-3.5c0 -1 .1 -1.4 -.5 -2c2.8 -.3 5.5 -1.4 5.5 -6a4.6 4.6 0 0 0 -1.3 -3.2a4.2 4.2 0 0 0 -.1 -3.2s-1.1 -.3 -3.5 1.3a12.3 12.3 0 0 0 -6.2 0c-2.4 -1.6 -3.5 -1.3 -3.5 -1.3a4.2 4.2 0 0 0 -.1 3.2a4.6 4.6 0 0 0 -1.3 3.2c0 4.6 2.7 5.7 5.5 6c-.6 .6 -.6 1.2 -.5 2v3.5"></path></svg>'
|
||||
url = "https://github.com/h-enk/doks"
|
||||
url = "https://github.com/gethyas/doks"
|
||||
post = "v0.1.0"
|
||||
weight = 30
|
||||
|
||||
[[footer]]
|
||||
name = "Privacy"
|
||||
name = "Privacy Policy"
|
||||
url = "/privacy/"
|
||||
weight = 10
|
||||
|
||||
[[footer]]
|
||||
name = "Terms"
|
||||
url = "/terms/"
|
||||
weight = 20
|
||||
# [[footer]]
|
||||
# name = "Terms of Service"
|
||||
# url = "/terms/"
|
||||
# weight = 20
|
||||
|
|
|
|||
|
|
@ -31,10 +31,6 @@
|
|||
source = "node_modules/@hyas/doks-core/assets"
|
||||
target = "assets"
|
||||
|
||||
[[mounts]]
|
||||
source = "node_modules/@hyas/doks-core/content"
|
||||
target = "content"
|
||||
|
||||
[[mounts]]
|
||||
source = "node_modules/@hyas/doks-core/data"
|
||||
target = "data"
|
||||
|
|
@ -75,6 +71,10 @@
|
|||
source = "node_modules/@hyas/inline-svg/layouts"
|
||||
target = "layouts"
|
||||
|
||||
[[mounts]]
|
||||
source = "themes/doks/layouts"
|
||||
target = "layouts"
|
||||
|
||||
[[mounts]]
|
||||
source = "archetypes"
|
||||
target = "archetypes"
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
image:
|
||||
## General
|
||||
type: page # page (default) or global
|
||||
widths: [480, 640, 768, 1024, 1366] # [600, 900, 1300] (default)
|
||||
widths: [600, 900, 1300] # [600, 900, 1300] (default)
|
||||
densities: [1,2] # [1,2] (default)
|
||||
formats: [original, webp] # [original, webp] (default)
|
||||
provider: null # null (default) or netlify
|
||||
|
|
@ -40,7 +40,7 @@ image:
|
|||
|
||||
# SEO (@hyas/seo)
|
||||
seo:
|
||||
description: "Doks is a Hyas theme for building custom, production-ready documentation websites."
|
||||
description: ""
|
||||
generate:
|
||||
title: true
|
||||
meta: true
|
||||
|
|
@ -51,7 +51,7 @@ seo:
|
|||
breadcrumbs: true
|
||||
title_tag:
|
||||
separator: "|"
|
||||
home_text: "Modern Documentation Theme"
|
||||
home_text: ""
|
||||
og_article_types: [post, posts, blog, news, article, articles, event, events, course, courses]
|
||||
jsonld_article_types: [article, articles]
|
||||
jsonld_news_article_types: [news, updates]
|
||||
|
|
|
|||
|
|
@ -7,12 +7,10 @@ module.exports = {
|
|||
autoprefixer(),
|
||||
purgecss({
|
||||
content: [
|
||||
'./node_modules/@hyas/core/layouts/**/*.html',
|
||||
'./node_modules/@hyas/seo/layouts/**/*.html',
|
||||
'./node_modules/@hyas/images/layouts/**/*.html',
|
||||
'./node_modules/@hyas/doks-core/layouts/**/*.html',
|
||||
'./node_modules/@hyas/doks-core/content/**/*.html',
|
||||
'./node_modules/@hyas/*/layouts/**/*.html',
|
||||
'./themes/*/layouts/**/*.html',
|
||||
'./layouts/**/*.html',
|
||||
'./content/**/*.html',
|
||||
'./content/**/*.md',
|
||||
],
|
||||
safelist: [
|
||||
|
|
|
|||
|
|
@ -1,9 +1,9 @@
|
|||
---
|
||||
title : "Modern Documentation Theme"
|
||||
description: "Build beautiful, high-performance documentation websites with Doks. Fast, flexible, and easy-to-use. Deploy anywhere."
|
||||
lead: "Build beautiful, high-performance documentation websites with Doks. Fast, flexible, and easy-to-use. Deploy anywhere."
|
||||
date: 2020-10-06T08:47:36+00:00
|
||||
lastmod: 2020-10-06T08:47:36+00:00
|
||||
title : "Welcome to Doks"
|
||||
description: ""
|
||||
lead: "Congrats on setting up a new Doks project!"
|
||||
date: 2023-09-07T16:33:54+02:00
|
||||
lastmod: 2023-09-07T16:33:54+02:00
|
||||
draft: false
|
||||
images: []
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1,11 +0,0 @@
|
|||
---
|
||||
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]
|
||||
|
|
@ -2,8 +2,8 @@
|
|||
title: "Blog"
|
||||
description: ""
|
||||
summary: ""
|
||||
date: 2023-05-17T08:59:31+02:00
|
||||
lastmod: 2023-05-17T08:59:31+02:00
|
||||
date: 2023-09-07T16:21:44+02:00
|
||||
lastmod: 2023-09-07T16:21:44+02:00
|
||||
draft: false
|
||||
weight: 50
|
||||
images: []
|
||||
|
|
|
|||
|
|
@ -1,18 +0,0 @@
|
|||
---
|
||||
title: "Doks 1.0"
|
||||
slug: "doks-1"
|
||||
description: ""
|
||||
summary: "Doks 1.0 is here! Doks is a fast, flexible, and easy-to-use documentation theme built on Hyas."
|
||||
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
|
||||
---
|
||||
|
||||
[..]
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
---
|
||||
title: "Example Post"
|
||||
description: ""
|
||||
summary: ""
|
||||
date: 2023-09-07T16:27:22+02:00
|
||||
lastmod: 2023-09-07T16:27:22+02:00
|
||||
draft: false
|
||||
weight: 50
|
||||
images: []
|
||||
categories: []
|
||||
tags: []
|
||||
contributors: []
|
||||
pinned: false
|
||||
homepage: false
|
||||
---
|
||||
|
|
@ -1,18 +0,0 @@
|
|||
---
|
||||
title: "Post With Image"
|
||||
description: ""
|
||||
summary: ""
|
||||
date: 2023-05-25T09:57:19+02:00
|
||||
lastmod: 2023-05-25T09:57:19+02:00
|
||||
draft: false
|
||||
weight: 50
|
||||
images: ["kris-mikael-krister-aGihPIbrtVE-unsplash.jpg"]
|
||||
categories: []
|
||||
tags: []
|
||||
contributors: []
|
||||
pinned: false
|
||||
homepage: false
|
||||
author:
|
||||
name: Henk Verlinde
|
||||
url: https://henkverlinde.com
|
||||
---
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 1.3 MiB |
|
|
@ -1,9 +0,0 @@
|
|||
---
|
||||
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: []
|
||||
---
|
||||
|
|
@ -1,12 +0,0 @@
|
|||
---
|
||||
title: "Henk Verlinde"
|
||||
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"
|
||||
---
|
||||
|
||||
[@h-enk](https://github.com/h-enk)
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 200 KiB |
|
|
@ -1,9 +1,15 @@
|
|||
---
|
||||
title : "Docs"
|
||||
description: "Docs Doks."
|
||||
lead: ""
|
||||
date: 2020-10-06T08:48:23+00:00
|
||||
lastmod: 2020-10-06T08:48:23+00:00
|
||||
title: "Docs"
|
||||
description: ""
|
||||
summary: ""
|
||||
date: 2023-09-07T16:12:03+02:00
|
||||
lastmod: 2023-09-07T16:12:03+02:00
|
||||
draft: false
|
||||
images: []
|
||||
menu:
|
||||
docs:
|
||||
parent: ""
|
||||
identifier: "docs-9602b15bad02600f3883f55e2ade6b81"
|
||||
weight: 999
|
||||
toc: true
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1,15 +0,0 @@
|
|||
---
|
||||
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,110 +0,0 @@
|
|||
---
|
||||
title: "Markdown Basic Syntax"
|
||||
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
|
||||
images: []
|
||||
menu:
|
||||
docs:
|
||||
parent: ""
|
||||
identifier: "markdown-basic-syntax-08aeef306d3f46c4e40c17b559b715c1"
|
||||
weight: 210
|
||||
toc: true
|
||||
---
|
||||
|
||||
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
|
||||
|
||||
```md
|
||||
# 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
|
||||
|
||||
```
|
||||
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 1.3 MiB |
|
|
@ -1,153 +0,0 @@
|
|||
---
|
||||
title: "Markdown Extended Syntax"
|
||||
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
|
||||
images: []
|
||||
menu:
|
||||
docs:
|
||||
parent: ""
|
||||
identifier: "markdown-extended-syntax-f467db1a842b35cffcbd916e2e6a56bc"
|
||||
weight: 220
|
||||
toc: true
|
||||
---
|
||||
|
||||
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
|
||||
|
||||
```md
|
||||
| Syntax | Description |
|
||||
| ----------- | ----------- |
|
||||
| Header | Title |
|
||||
| Paragraph | Text |
|
||||
```
|
||||
|
||||
| Syntax | Description |
|
||||
| ----------- | ----------- |
|
||||
| Header | Title |
|
||||
| Paragraph | Text |
|
||||
|
||||
## 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
|
||||
|
||||
{{< 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:
|
||||
|
||||
## Unsupported elements
|
||||
|
||||
{{< 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>.
|
||||
```
|
||||
|
||||
I need to highlight these <mark>very important words</mark>.
|
||||
|
||||
### Subscript
|
||||
|
||||
```md
|
||||
H<sub>2</sub>O
|
||||
```
|
||||
|
||||
H<sub>2</sub>O
|
||||
|
||||
### Superscript
|
||||
|
||||
```md
|
||||
X<sup>2</sup>
|
||||
```
|
||||
|
||||
X<sup>2</sup>
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 3.6 MiB |
Binary file not shown.
Binary file not shown.
|
|
@ -1,296 +0,0 @@
|
|||
---
|
||||
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
|
||||
|
||||
Insert 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
|
||||
{{</* inline-svg src="svgs/logos/logo-netlify-small-fullcolor-lightmode.svg" width="192px" height="79px" class="svg-inline-custom svg-lightmode" */>}}
|
||||
|
||||
{{</* inline-svg src="svgs/logos/logo-netlify-small-fullcolor-darkmode.svg" width="192px" height="79px" class="svg-inline-custom svg-darkmode" */>}}
|
||||
```
|
||||
|
||||
{{< inline-svg src="svgs/logos/logo-netlify-small-fullcolor-lightmode.svg" width="192px" height="79px" class="svg-inline-custom svg-lightmode" >}}
|
||||
|
||||
{{< inline-svg src="svgs/logos/logo-netlify-small-fullcolor-darkmode.svg" width="192px" height="79px" class="svg-inline-custom svg-darkmode" >}}
|
||||
|
||||
### Page resource
|
||||
|
||||
{{< callout src="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
|
||||
{{</* inline-svg src="logo-netlify-monogram-monochrome-lightmode.svg" width="64px" height="57px" class="svg-inline-custom svg-monochrome" */>}}
|
||||
```
|
||||
|
||||
{{< inline-svg src="logo-netlify-monogram-monochrome-lightmode.svg" width="64px" height="57px" class="svg-inline-custom svg-monochrome" >}}
|
||||
|
||||
### Tabler icons
|
||||
|
||||
{{< callout src="copy" >}}
|
||||
Copy the icon name from [Tabler Icons](https://tabler-icons.io/) by clicking on it's name.
|
||||
{{< /callout >}}
|
||||
|
||||
Add a Tabler icon:
|
||||
|
||||
```md
|
||||
{{</* inline-svg "coffee" */>}}
|
||||
```
|
||||
|
||||
{{< inline-svg "coffee" >}}
|
||||
|
||||
Specify [SVG attributes](https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute), for example:
|
||||
|
||||
```md
|
||||
{{</* inline-svg src="hand-rock" stroke-width="1" stroke="#ee52b7" height="3rem" width="3rem" class="svg-inline-custom" */>}}
|
||||
```
|
||||
|
||||
{{< inline-svg src="hand-rock" stroke-width="1" stroke="#ee52b7" height="3rem" width="3rem" class="svg-inline-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 "Details" */>}}
|
||||
Something small enough to escape casual notice.
|
||||
{{</* /details */>}}
|
||||
```
|
||||
|
||||
{{< details "Details" >}}
|
||||
Something small enough to escape casual notice.
|
||||
{{< /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 >}}
|
||||
|
||||
## Image
|
||||
|
||||
### Assets directory
|
||||
|
||||
Add an image from the assets directory:
|
||||
|
||||
```md
|
||||
{{</* picture src="assets/images/bozhin-karaivanov-3HnVKfQZGTQ-unsplash.jpg" alt="Red raspberry" */>}}
|
||||
```
|
||||
|
||||
{{< picture src="assets/images/bozhin-karaivanov-3HnVKfQZGTQ-unsplash.jpg" alt="Red raspberry" >}}
|
||||
|
||||
### Page resource
|
||||
|
||||
```md
|
||||
{{</* picture src="bozhin-karaivanov-zs6GW81O538-unsplash.jpg" alt="Red apples on a tree" */>}}
|
||||
```
|
||||
|
||||
{{< picture src="bozhin-karaivanov-zs6GW81O538-unsplash.jpg" alt="Red apples on a tree" >}}
|
||||
|
||||
## Video
|
||||
|
||||
```md
|
||||
{{</* video src="flower" autoplay="true" muted="true" */>}}
|
||||
```
|
||||
|
||||
{{< video src="flower" autoplay="true" muted="true" >}}
|
||||
|
|
@ -1,16 +0,0 @@
|
|||
<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>
|
||||
|
Before Width: | Height: | Size: 1.4 KiB |
|
|
@ -0,0 +1,15 @@
|
|||
---
|
||||
title: "Guides"
|
||||
description: ""
|
||||
summary: ""
|
||||
date: 2023-09-07T16:06:50+02:00
|
||||
lastmod: 2023-09-07T16:06:50+02:00
|
||||
draft: false
|
||||
images: []
|
||||
menu:
|
||||
docs:
|
||||
parent: ""
|
||||
identifier: "guides-4e0d0e0f89f7decc11eaad4ae9193018"
|
||||
weight: 800
|
||||
toc: true
|
||||
---
|
||||
|
|
@ -0,0 +1,21 @@
|
|||
---
|
||||
title: "Example Guide"
|
||||
description: ""
|
||||
summary: ""
|
||||
date: 2023-09-07T16:04:48+02:00
|
||||
lastmod: 2023-09-07T16:04:48+02:00
|
||||
draft: false
|
||||
images: []
|
||||
menu:
|
||||
docs:
|
||||
parent: ""
|
||||
identifier: "example-6a1a6be4373e933280d78ea53de6158e"
|
||||
weight: 810
|
||||
toc: true
|
||||
---
|
||||
|
||||
Guides lead a user through a specific task they want to accomplish, often with a sequence of steps. Writing a good guide requires thinking about what your users are trying to do.
|
||||
|
||||
## Further reading
|
||||
|
||||
- Read [about how-to guides](https://diataxis.fr/how-to-guides/) in the Diátaxis framework
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
---
|
||||
title: "Reference"
|
||||
description: ""
|
||||
summary: ""
|
||||
date: 2023-09-07T16:12:37+02:00
|
||||
lastmod: 2023-09-07T16:12:37+02:00
|
||||
draft: false
|
||||
images: []
|
||||
menu:
|
||||
docs:
|
||||
parent: ""
|
||||
identifier: "reference-22e9ba8aefa7ef9891199cf8db3a08cd"
|
||||
weight: 900
|
||||
toc: true
|
||||
---
|
||||
|
|
@ -0,0 +1,21 @@
|
|||
---
|
||||
title: "Example Reference"
|
||||
description: ""
|
||||
summary: ""
|
||||
date: 2023-09-07T16:13:18+02:00
|
||||
lastmod: 2023-09-07T16:13:18+02:00
|
||||
draft: false
|
||||
images: []
|
||||
menu:
|
||||
docs:
|
||||
parent: ""
|
||||
identifier: "example-ee51430687e728ba6e68dea3359133ad"
|
||||
weight: 910
|
||||
toc: true
|
||||
---
|
||||
|
||||
Reference pages are ideal for outlining how things work in terse and clear terms. Less concerned with telling a story or addressing a specific use case, they should give a comprehensive outline of what your documenting.
|
||||
|
||||
## Further reading
|
||||
|
||||
- Read [about reference](https://diataxis.fr/reference/) in the Diátaxis framework
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
---
|
||||
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
|
||||
---
|
||||
|
|
@ -1,66 +0,0 @@
|
|||
---
|
||||
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 fast, flexible, and easy-to-use documentation theme built on [Hyas](https://gethyas.com/).
|
||||
|
||||
## 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
|
||||
|
||||
New contributors welcome! Check out our [Contributor Guides](https://getdoks.org/contribute/) for help getting started.
|
||||
|
|
@ -1,11 +1,10 @@
|
|||
---
|
||||
title: "Privacy Policy"
|
||||
description: ""
|
||||
date: 2020-08-27T19:23:18+02:00
|
||||
lastmod: 2023-04-14T13:24:35+02:00
|
||||
summary: ""
|
||||
date: 2023-09-07T17:19:07+02:00
|
||||
lastmod: 2023-09-07T17:19:07+02:00
|
||||
draft: false
|
||||
images: []
|
||||
type: "legal"
|
||||
---
|
||||
|
||||
[Privacy Policy]
|
||||
|
|
|
|||
|
|
@ -1,11 +0,0 @@
|
|||
---
|
||||
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]
|
||||
|
|
@ -1,11 +0,0 @@
|
|||
---
|
||||
title: "Versions"
|
||||
description: ""
|
||||
lead: "An appendix of hosted documentation for nearly every release of Doks, from v0 through v3."
|
||||
date: 2021-09-24T08:50:23+02:00
|
||||
lastmod: 2021-09-24T08:50:23+02:00
|
||||
draft: true
|
||||
images: []
|
||||
layout: versions
|
||||
url: "/docs/versions/"
|
||||
---
|
||||
|
|
@ -14,7 +14,7 @@ other = "No recent searches"
|
|||
other = "No results"
|
||||
|
||||
[get-started]
|
||||
other = "Get Started"
|
||||
other = "Example Guide"
|
||||
|
||||
[on-this-page]
|
||||
other = "On this page"
|
||||
|
|
|
|||
12
netlify.toml
12
netlify.toml
|
|
@ -21,18 +21,6 @@
|
|||
[context.next.environment]
|
||||
HUGO_ENV = "next"
|
||||
|
||||
# [[plugins]]
|
||||
# package = "netlify-plugin-submit-sitemap"
|
||||
#
|
||||
# [plugins.inputs]
|
||||
# baseUrl = "/"
|
||||
# sitemapPath = "/sitemap.xml"
|
||||
# ignorePeriod = 0
|
||||
# providers = [
|
||||
# "google",
|
||||
# "yandex"
|
||||
# ]
|
||||
|
||||
[dev]
|
||||
framework = "#custom"
|
||||
command = "pnpm dev"
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load Diff
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"name": "doks",
|
||||
"version": "1.0.0-rc.2",
|
||||
"version": "1.0.0",
|
||||
"description": "Doks theme",
|
||||
"author": "Hyas",
|
||||
"license": "MIT",
|
||||
|
|
@ -30,7 +30,7 @@
|
|||
"version": "auto-changelog -p && git add CHANGELOG.md"
|
||||
},
|
||||
"dependencies": {
|
||||
"@hyas/doks-core": "^1.0.3"
|
||||
"@hyas/doks-core": "^1.0.4"
|
||||
},
|
||||
"devDependencies": {
|
||||
"auto-changelog": "^2.4.0"
|
||||
|
|
|
|||
4701
pnpm-lock.yaml
4701
pnpm-lock.yaml
File diff suppressed because it is too large
Load Diff
File diff suppressed because one or more lines are too long
|
|
@ -1 +0,0 @@
|
|||
{"Target":"main.c99deccbfc057753a0a5091b75ff46cae88dd4c3d25a1ee61634b24e84afe88b9e17d96aae1de064c0076194222bffc7848dc213479955268a344541b558ffba.css","MediaType":"text/css","Data":{"Integrity":"sha512-yZ3sy/wFd1OgpQkbdf9GyuiN1MPSWh7mFjSyToSv6IueF9lqrh3gZMAHYZQiK//HhI3CE0eZVSaKNEVBtVj/ug=="}}
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 75 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 98 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 124 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 160 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 22 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 27 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 36 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 44 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 49 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 60 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 68 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 103 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 122 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 174 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 23 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 31 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 36 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 49 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 44 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 64 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 362 B |
Binary file not shown.
|
Before Width: | Height: | Size: 48 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 2.6 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 75 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 98 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 124 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 160 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 22 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 27 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 36 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 44 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 49 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 60 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 119 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 143 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 183 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 226 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 37 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 44 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 58 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 70 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 76 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 91 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 175 KiB |
|
|
@ -1,7 +1,7 @@
|
|||
name = "Doks"
|
||||
license = "MIT"
|
||||
licenselink = "https://github.com/gethyas/doks/blob/master/LICENSE"
|
||||
description = "Build beautiful, high-performance documentation websites with Doks. Fast, flexible, and easy-to-use. Deploy anywhere."
|
||||
description = "Build beautiful, high-performance documentation websites with Doks."
|
||||
|
||||
homepage = "https://github.com/gethyas/doks"
|
||||
demosite = "https://doks.netlify.app"
|
||||
|
|
|
|||
|
|
@ -0,0 +1,59 @@
|
|||
{{ define "main" }}
|
||||
<section class="section container-fluid mt-n3 pb-3">
|
||||
<div class="row justify-content-center">
|
||||
<div class="col-lg-12 text-center">
|
||||
<h1>{{ .Title }}</h1>
|
||||
</div>
|
||||
<div class="col-lg-9 col-xl-8 text-center">
|
||||
<p class="lead">{{ .Params.lead | safeHTML }}</p>
|
||||
<a class="btn btn-primary btn-cta rounded-pill btn-lg my-3" href="/docs/{{ if site.Data.doks.docsVersioning }}{{ site.Data.doks.docsVersion }}/{{ end }}guides/example-guide/" role="button">{{ i18n "get-started" }}</a>
|
||||
{{ .Content }}
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
{{ end }}
|
||||
|
||||
{{ define "sidebar-prefooter" }}
|
||||
{{ if site.Data.doks.backgroundDots -}}
|
||||
<div class="d-flex justify-content-start">
|
||||
<div class="bg-dots"></div>
|
||||
</div>
|
||||
{{ end -}}
|
||||
{{ if eq $.Site.Language.LanguageName "English" }}
|
||||
<section class="section section-md section-features">
|
||||
<div class="container">
|
||||
<div class="row justify-content-center text-center">
|
||||
<div class="col-lg-5">
|
||||
<h2 class="h4">Update content</h2>
|
||||
<p>Edit <code>content/_index.md</code> to see this page change.</p>
|
||||
</div>
|
||||
<div class="col-lg-5">
|
||||
<h2 class="h4">Add new content</h2>
|
||||
<p>Add Markdown files to <code>content</code> to create new pages.</p>
|
||||
</div>
|
||||
<div class="col-lg-5">
|
||||
<h2 class="h4">Configure your site</h2>
|
||||
<p>Edit your config in <code>config/_default/hyas/doks.toml</code>.</p>
|
||||
</div>
|
||||
<div class="col-lg-5">
|
||||
<h2 class="h4">Read the docs</h2>
|
||||
<p>Learn more in the <a href="https://getdoks.org/">Docs</a>.</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
{{ end }}
|
||||
{{ end }}
|
||||
|
||||
{{ define "sidebar-footer" }}
|
||||
{{ if site.Data.doks.sectionFooter -}}
|
||||
<section class="section section-md container-fluid bg-light">
|
||||
<div class="row justify-content-center text-center">
|
||||
<div class="col-lg-7">
|
||||
<h2 class="mt-2">Start building with Doks today</h2>
|
||||
<a class="btn btn-primary rounded-pill px-4 my-2" href="/docs/{{ if site.Data.doks.docsVersioning }}{{ site.Data.doks.docsVersion }}/{{ end }}prologue/introduction/" role="button">{{ i18n "get-started" }}</a>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
{{ end -}}
|
||||
{{ end }}
|
||||
Loading…
Reference in New Issue