feat: update for Doks v1.0.0-beta.2
This commit is contained in:
Henk Verlinde
parent
d14c659631
commit
9a3994f695
|
|
@ -0,0 +1,37 @@
|
|||
name: Continuous Integration - Action
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: master
|
||||
pull_request:
|
||||
branches: master
|
||||
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ${{ matrix.os }}
|
||||
|
||||
strategy:
|
||||
matrix:
|
||||
os: [ubuntu-latest]
|
||||
node-version: [18.x, 20.x]
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
- uses: pnpm/action-setup@v2
|
||||
with:
|
||||
version: 7
|
||||
|
||||
- name: Use Node.js ${{ matrix.node-version }}
|
||||
uses: actions/setup-node@v3
|
||||
with:
|
||||
node-version: ${{ matrix.node-version }}
|
||||
cache: 'pnpm'
|
||||
|
||||
- name: Install dependencies
|
||||
run: pnpm install
|
||||
|
||||
- name: Run test script
|
||||
run: pnpm test
|
||||
|
||||
- name: Build production website
|
||||
run: pnpm build
|
||||
|
|
@ -1,3 +1,4 @@
|
|||
title = "Doks"
|
||||
baseurl = "/"
|
||||
canonifyURLs = false
|
||||
disableAliases = true
|
||||
|
|
@ -16,6 +17,11 @@ defaultContentLanguage = "en"
|
|||
disableLanguages = ["de", "nl"]
|
||||
defaultContentLanguageInSubdir = false
|
||||
|
||||
copyRight = "Copyright (c) 2020-2023 Henk Verlinde"
|
||||
|
||||
[social]
|
||||
twitter = "getdoks"
|
||||
|
||||
[outputs]
|
||||
home = ["HTML", "RSS", "searchIndex"]
|
||||
section = ["HTML", "RSS", "SITEMAP"]
|
||||
|
|
@ -70,3 +76,10 @@ rel = "sitemap"
|
|||
[[related.indices]]
|
||||
name = "date"
|
||||
weight = 10
|
||||
|
||||
[imaging]
|
||||
anchor = 'Smart'
|
||||
bgColor = '#fff'
|
||||
hint = 'photo'
|
||||
quality = 90
|
||||
resampleFilter = 'Lanczos'
|
||||
|
|
|
|||
|
|
@ -14,6 +14,11 @@
|
|||
source = "node_modules/@hyas/seo/layouts"
|
||||
target = "layouts"
|
||||
|
||||
[[mounts]]
|
||||
source = "node_modules/@hyas/images/assets"
|
||||
target = "assets"
|
||||
excludeFiles = "/scss/**.scss"
|
||||
|
||||
[[mounts]]
|
||||
source = "node_modules/@hyas/images/layouts"
|
||||
target = "layouts"
|
||||
|
|
@ -63,7 +68,11 @@
|
|||
target = "assets/svgs/tabler-icons"
|
||||
|
||||
[[mounts]]
|
||||
source = "node_modules/@hyas/tabler-icons/layouts"
|
||||
source = "assets/svgs"
|
||||
target = "assets/svgs"
|
||||
|
||||
[[mounts]]
|
||||
source = "node_modules/@hyas/inline-svg/layouts"
|
||||
target = "layouts"
|
||||
|
||||
[[mounts]]
|
||||
|
|
|
|||
|
|
@ -1,58 +0,0 @@
|
|||
# Hyas (gethyas)
|
||||
|
||||
## Feed
|
||||
copyRight = "Copyright (c) 2020-2021 Henk Verlinde"
|
||||
|
||||
# SEO (@hyas/seo)
|
||||
|
||||
## Homepage
|
||||
title = "Doks"
|
||||
titleSeparator = "-" # - (default)
|
||||
titleAddition = "Modern Documentation Theme"
|
||||
description = "Doks is a Hyas theme for building custom, production-ready documentation websites." # Default description
|
||||
|
||||
## Open Graph
|
||||
images = ["hyas.png"]
|
||||
ogLocale = "en_US"
|
||||
titleHome = "Modern Documentation Theme"
|
||||
|
||||
## Twitter Cards
|
||||
twitterSite = "@gethyas"
|
||||
twitterCreator = "@henkverlinde"
|
||||
|
||||
## JSON-LD
|
||||
schemaType = "Organization" # Organization (default) or Person
|
||||
schemaName = "Hyas"
|
||||
schemaAuthor = "Henk Verlinde"
|
||||
schemaAuthorTwitter = "https://twitter.com/henkverlinde"
|
||||
schemaAuthorLinkedIn = "https://www.linkedin.com/in/henkverlinde/"
|
||||
schemaAuthorGitHub = "https://github.com/h-enk"
|
||||
schemaLocale = "en-US"
|
||||
schemaLogo = "logo-hyas.png"
|
||||
schemaLogoWidth = 512
|
||||
schemaLogoHeight = 512
|
||||
schemaImage = "hyas.png"
|
||||
schemaImageWidth = 1280
|
||||
schemaImageHeight = 640
|
||||
schemaTwitter = "https://twitter.com/gethyas"
|
||||
schemaLinkedIn = ""
|
||||
schemaGitHub = "https://github.com/h-enk/hyas"
|
||||
|
||||
# Images (@hyas/images)
|
||||
|
||||
[lazyimg]
|
||||
resizer = "auto"
|
||||
renderer = "lqip-webp" # "lqip (default)"
|
||||
|
||||
# Resizer options:
|
||||
lqipSize = "120x Gaussian"
|
||||
maxSize = "1024x" # "1920x" (default)
|
||||
responsiveSizes = [ "320x", "640x", "768x", "1024x", "1366x", "1600x", "1920x" ]
|
||||
resizeOptions = "Lanczos q95"
|
||||
|
||||
# Renderer options:
|
||||
class = "img-fluid"
|
||||
# alt = "" # Default alt tag
|
||||
noscript = true
|
||||
|
||||
errorHandler = "warning" # "warning-remote" (default)
|
||||
|
|
@ -0,0 +1,64 @@
|
|||
# Images (@hyas/images)
|
||||
image:
|
||||
## General
|
||||
type: page # page (default) or global
|
||||
widths: [480, 640, 768, 1024, 1366] # [600, 900, 1300] (default)
|
||||
densities: [1,2] # [1,2] (default)
|
||||
formats: [original, webp] # [original, webp] (default)
|
||||
provider: null # null (default) or netlify
|
||||
loading: lazysizes # auto (default), lazy, or lazysizes
|
||||
class: "img-fluid blur-up" # img-fluid (default)
|
||||
output: picture # picture (default), figure, or img
|
||||
noscript: false # false (default) or true
|
||||
|
||||
## Placeholder
|
||||
placeholder: lqip # null (default), lqip, dominant, or [black, [gray-100..gray-900], white]
|
||||
lqip_div_factor: 5 # 5 (default)
|
||||
lqip_blur_amount: 5 # 5 (default)
|
||||
gif_div_factor: 10 # 10 (default)
|
||||
|
||||
## Figure
|
||||
target: "_blank" # _blank (default)
|
||||
rel: "noopener, noreferrer" # noopener, noreferrer (default)
|
||||
figure_class: "figure" # figure (default)
|
||||
figure_image_class: "figure-img img-fluid blur-up" # "figure-img img-fluid" (default)
|
||||
figcaption_class: figure-caption # figure-caption (default)
|
||||
figcaption_title_h: 4 # 4 (default)
|
||||
attr_link_target: "_blank" # _blank (default)
|
||||
attr_link_rel: "noopener, noreferrer" # noopener, noreferrer (default)
|
||||
|
||||
## Render hook
|
||||
render_hook: true # false (default) or true
|
||||
render_hook_wrapper_class: img-wrapper # img-wrapper (default)
|
||||
|
||||
## Shortcode
|
||||
shortcode_wrapper_class: img-wrapper # img-wrapper (default)
|
||||
|
||||
## Debugging
|
||||
suppress_width_warning: false # false (default) or true
|
||||
debug: false # false (default) or true
|
||||
|
||||
# SEO (@hyas/seo)
|
||||
seo:
|
||||
description: "Doks is a Hyas theme for building custom, production-ready documentation websites."
|
||||
generate:
|
||||
title: true
|
||||
meta: true
|
||||
twitter: true
|
||||
og: true
|
||||
jsonld:
|
||||
article: true
|
||||
breadcrumbs: true
|
||||
title_tag:
|
||||
separator: "|"
|
||||
home_text: "Modern Documentation Theme"
|
||||
og_article_types: [post, posts, blog, news, article, articles, event, events, course, courses]
|
||||
jsonld_article_types: [article, articles]
|
||||
jsonld_news_article_types: [news, updates]
|
||||
jsonld_blog_posting_types: [post, posts, blog]
|
||||
image: "/images/hyas-schema-image.png"
|
||||
private: false
|
||||
|
||||
# Inline SVG (@hyas/inline-svg)
|
||||
inline_svg:
|
||||
icon_set_dir: "tabler-icons" # tabler-icons (default)
|
||||
|
|
@ -12,4 +12,7 @@ tags: []
|
|||
contributors: []
|
||||
pinned: false
|
||||
homepage: false
|
||||
author:
|
||||
name: Henk Verlinde
|
||||
url: https://henkverlinde.com
|
||||
---
|
||||
|
|
|
|||
|
|
@ -23,7 +23,7 @@ Refer to [components](https://getdoks.org/docs/components/) for more information
|
|||
|
||||
## SVG
|
||||
|
||||
Add an [SVG](https://developer.mozilla.org/en-US/docs/Web/SVG) from the assets directory, page resources, or Tabler icons.
|
||||
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.
|
||||
|
|
@ -34,51 +34,50 @@ The [SVG](https://developer.mozilla.org/en-US/docs/Web/SVG) gets embedded into t
|
|||
Add e.g. a logo from the `assets` directory:
|
||||
|
||||
```md
|
||||
{{</* svg icon="svgs/logos/logo-netlify-small-fullcolor-lightmode.svg" width="192px" height="79px" class="icon-custom icon-lightmode" */>}}
|
||||
{{</* inline-svg src="svgs/logos/logo-netlify-small-fullcolor-lightmode.svg" width="192px" height="79px" class="svg-inline-custom svg-lightmode" */>}}
|
||||
|
||||
{{</* svg icon="svgs/logos/logo-netlify-small-fullcolor-darkmode.svg" width="192px" height="79px" class="icon-custom icon-darkmode" */>}}
|
||||
{{</* inline-svg src="svgs/logos/logo-netlify-small-fullcolor-darkmode.svg" width="192px" height="79px" class="svg-inline-custom svg-darkmode" */>}}
|
||||
```
|
||||
|
||||
{{< svg icon="svgs/logos/logo-netlify-small-fullcolor-lightmode.svg" width="192px" height="79px" class="icon-custom icon-lightmode" >}}
|
||||
{{< inline-svg src="svgs/logos/logo-netlify-small-fullcolor-lightmode.svg" width="192px" height="79px" class="svg-inline-custom svg-lightmode" >}}
|
||||
|
||||
{{< svg icon="svgs/logos/logo-netlify-small-fullcolor-darkmode.svg" width="192px" height="79px" class="icon-custom icon-darkmode" >}}
|
||||
{{< inline-svg src="svgs/logos/logo-netlify-small-fullcolor-darkmode.svg" width="192px" height="79px" class="svg-inline-custom svg-darkmode" >}}
|
||||
|
||||
### Page resource
|
||||
|
||||
{{< callout icon="info-circle" >}}
|
||||
{{< 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
|
||||
:
|
||||
Add e.g a monogram:
|
||||
|
||||
```md
|
||||
{{</* svg icon="logo-netlify-monogram-monochrome-lightmode.svg" width="64px" height="57px" class="icon-custom icon-monochrome" */>}}
|
||||
{{</* inline-svg src="logo-netlify-monogram-monochrome-lightmode.svg" width="64px" height="57px" class="svg-inline-custom svg-monochrome" */>}}
|
||||
```
|
||||
|
||||
{{< svg icon="logo-netlify-monogram-monochrome-lightmode.svg" width="64px" height="57px" class="icon-custom icon-monochrome" >}}
|
||||
{{< inline-svg src="logo-netlify-monogram-monochrome-lightmode.svg" width="64px" height="57px" class="svg-inline-custom svg-monochrome" >}}
|
||||
|
||||
### Tabler icons
|
||||
|
||||
{{< callout icon="copy" >}}
|
||||
{{< 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
|
||||
{{</* svg "hand-rock" */>}}
|
||||
{{</* inline-svg "coffee" */>}}
|
||||
```
|
||||
|
||||
{{< svg "hand-rock" >}}
|
||||
{{< inline-svg "coffee" >}}
|
||||
|
||||
Specify [SVG attributes](https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute), for example:
|
||||
|
||||
```md
|
||||
{{</* svg icon="hand-rock" stroke-width="1" stroke="#ee52b7" height="3rem" width="3rem" class="icon-custom" */>}}
|
||||
{{</* inline-svg src="hand-rock" stroke-width="1" stroke="#ee52b7" height="3rem" width="3rem" class="svg-inline-custom" */>}}
|
||||
```
|
||||
|
||||
{{< svg icon="hand-rock" stroke-width="1" stroke="#ee52b7" height="3rem" width="3rem" class="icon-custom" >}}
|
||||
{{< inline-svg src="hand-rock" stroke-width="1" stroke="#ee52b7" height="3rem" width="3rem" class="svg-inline-custom" >}}
|
||||
|
||||
## Callouts
|
||||
|
||||
|
|
@ -275,18 +274,18 @@ yarn install
|
|||
Add an image from the assets directory:
|
||||
|
||||
```md
|
||||
{{</* lazyimg img="images/bozhin-karaivanov-3HnVKfQZGTQ-unsplash.jpg" alt="Red raspberry" */>}}
|
||||
{{</* picture src="assets/images/bozhin-karaivanov-3HnVKfQZGTQ-unsplash.jpg" alt="Red raspberry" */>}}
|
||||
```
|
||||
|
||||
{{< lazyimg img="images/bozhin-karaivanov-3HnVKfQZGTQ-unsplash.jpg" alt="Red raspberry" >}}
|
||||
{{< picture src="assets/images/bozhin-karaivanov-3HnVKfQZGTQ-unsplash.jpg" alt="Red raspberry" >}}
|
||||
|
||||
### Page resource
|
||||
|
||||
```md
|
||||
{{</* lazyimg img="bozhin-karaivanov-zs6GW81O538-unsplash.jpg" alt="Red apples on a tree" */>}}
|
||||
{{</* picture src="bozhin-karaivanov-zs6GW81O538-unsplash.jpg" alt="Red apples on a tree" */>}}
|
||||
```
|
||||
|
||||
{{< lazyimg img="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
|
||||
|
||||
|
|
|
|||
22
netlify.toml
22
netlify.toml
|
|
@ -21,17 +21,17 @@
|
|||
[context.next.environment]
|
||||
HUGO_ENV = "next"
|
||||
|
||||
[[plugins]]
|
||||
package = "netlify-plugin-submit-sitemap"
|
||||
|
||||
[plugins.inputs]
|
||||
baseUrl = "/"
|
||||
sitemapPath = "/sitemap.xml"
|
||||
ignorePeriod = 0
|
||||
providers = [
|
||||
"google",
|
||||
"yandex"
|
||||
]
|
||||
# [[plugins]]
|
||||
# package = "netlify-plugin-submit-sitemap"
|
||||
#
|
||||
# [plugins.inputs]
|
||||
# baseUrl = "/"
|
||||
# sitemapPath = "/sitemap.xml"
|
||||
# ignorePeriod = 0
|
||||
# providers = [
|
||||
# "google",
|
||||
# "yandex"
|
||||
# ]
|
||||
|
||||
[dev]
|
||||
framework = "#custom"
|
||||
|
|
|
|||
11
package.json
11
package.json
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"name": "doks",
|
||||
"version": "1.0.0-beta.1",
|
||||
"version": "1.0.0-beta.2",
|
||||
"description": "Doks theme",
|
||||
"main": "index.js",
|
||||
"scripts": {
|
||||
|
|
@ -36,12 +36,13 @@
|
|||
"author": "Henk Verlinde",
|
||||
"license": "MIT",
|
||||
"bugs": {
|
||||
"url": "https://github.com/hyas/doks/issues"
|
||||
"url": "https://github.com/gethyas/doks/issues"
|
||||
},
|
||||
"homepage": "https://github.com/hyas/doks#readme",
|
||||
"homepage": "https://github.com/gethyas/doks#readme",
|
||||
"devDependencies": {
|
||||
"@hyas/doks-core": "^0.1.8",
|
||||
"@hyas/doks-core": "^1.0.0",
|
||||
"auto-changelog": "^2.4.0",
|
||||
"shx": "^0.3.4"
|
||||
}
|
||||
},
|
||||
"packageManager": "pnpm@8.3.1"
|
||||
}
|
||||
|
|
|
|||
1395
pnpm-lock.yaml
1395
pnpm-lock.yaml
File diff suppressed because it is too large
Load Diff
Loading…
Reference in New Issue