Summary

Update offcanvas navbar for Offcanvas in navbars support introduced with Bootstrap v5.1.

Basic example

See also:

• Offcanvas

Motivation

DRY

Description

Describe the issue that you're seeing.

Steps to reproduce

1. Got to https://getdoks.org/docs/prologue/introduction/
2. Open Developer tools

Expected result

Right positioning icons mobile is 1.5rem.

Actual result

Environment

Paste the information here as shown by hyas info

Summary

Brief explanation of the feature.

Basic example

Include a basic example or links here.

Motivation

Why are we doing this? What use cases does it support? What is the expected outcome?

My advice:

• ONLY set your production URL in ./config/_default/config.toml — so, do NOT set any URL in ./config/next/config.toml or ./config/production/config.toml. Then, Hugo, Netlify and others can perfectly make out the correct URL to use.
  `

This conflicts with the documentation

Make sure to set baseURL in ./config/production/config.toml to the URL of your Doks website in production.

Originally posted by @FactoryOptic in thuliteio/doks#718 (reply in thread)

Description

Describe the issue that you're seeing.

Steps to reproduce

Clear steps describing how to reproduce the issue. Please please please link to a demo project if possible, this makes your issue much easier to diagnose (seriously).

• https://validator.w3.org/nu/?doc=https%3A%2F%2Fgetdoks.org%2F
• https://validator.w3.org/nu/?doc=https%3A%2F%2Fgetdoks.org%2Fdocs%2Fprologue%2Fintroduction%2F
• https://validator.w3.org/nu/?doc=https%3A%2F%2Fgetdoks.org%2Ftutorial%2Finstall-requirements%2F

Expected result

What should happen?

Actual result

What happened.

Environment

Paste the information here as shown by hyas info

• Dropdown in main navbar (like for example multilingual dropdown)
• Override component to use light theme (like gethyas.com)

Contents:

• Hyas
• Images
• SVG
• SEO

Summary

Brief explanation of the feature.

Basic example

Include a basic example or links here.

Motivation

Why are we doing this? What use cases does it support? What is the expected outcome?

The documentation for customizing scss is lacking, the entirety of the documentation is literally Set variables in ./assets/scss/common/_variables.scss. This is not enough to make sense of what to do.

I've created the _variables.scss file above and entered there variables into it. I would expect the button on the landing page to have black text after doing this, but nothing changes at all.

$color-btn-bg: #000000
$color-btn-text: #000000

These variables don't seem to be in the files when cloning the child version of the theme (which I thought would include "changing colors" in "minor customization"), I had to find the above variables in the doks main repo, there they are defined in assets/scss/components/_buttons.scss. Why does my variable settings not change anything? Did I do something wrong, or is setting variables in ./assets/scss/common/_variables.scss actually not enough?

TL;DR

I figured out how to fix this. (I know very little about Hugo)
See last comment in chain for resolution.
** note I only see this issue on the starter-theme, not the child theme, not sure what is going on **

Description

Clean build of github.com/h-enk/doks.git has truncated content AFTER the first alert at this url: http://localhost:1313/docs/prologue/introduction/

Steps to reproduce

cd
git clone https://github.com/h-enk/doks.git foo
cd foo
npm install
npm run start
open http://localhost:1313/docs/prologue/introduction/     # different terminal window
# scroll down to alert and see truncated content

Expected result

Page should include multiple alerts and Quick Start heading.

Actual result

Page includes single alerts and does not include Quick Start heading.

Basically, page should look like: https://getdoks.org/docs/prologue/introduction/
But, the page does not, the page appears truncated.

What happened.

Environment

c@camerons-mini ~/foo (master)> npm run check

@hyas/[email protected] precheck
npm version

{
'@hyas/doks': '0.2.3',
npm: '7.5.3',
node: '15.10.0',
v8: '8.6.395.17-node.25',
uv: '1.41.0',
zlib: '1.2.11',
brotli: '1.0.9',
ares: '1.17.1',
modules: '88',
nghttp2: '1.42.0',
napi: '7',
llhttp: '2.1.3',
openssl: '1.1.1j',
cldr: '38.1',
icu: '68.2',
tz: '2020d',
unicode: '13.0'
}

@hyas/[email protected] check
hugo version

hugo v0.83.1-5AFE0A57+extended darwin/amd64 BuildDate=2021-05-02T14:38:05Z VendorInfo=gohugoio
c@camerons-mini ~/foo (master)>

Summary

Brief explanation of the feature.

Basic example

Include a basic example or links here.

Motivation

Why are we doing this? What use cases does it support? What is the expected outcome?

• DocSearch

Summary

• KubeDL
• APKLab
• Invidious
• Lotus Docs
• causalscience.org

Basic example

Include a basic example or links here.

Motivation

Why are we doing this? What use cases does it support? What is the expected outcome?

I build doks with this command：

npm create hyas@latest -- --template doks

and got some questions:

1. Find code block css of root element --ec-brdRad is 0px, Hyas site and Expressive-code official website is --ec-brdRad: 0.3rem;.

2. The code block in .md not support like :

    ```js title="xx" 
    ...some code
    ```

   or

    ```js wrap
    ...some code
    ```

Thank you for your time.

Description

Describe the issue that you're seeing.

Steps to reproduce

Clear steps describing how to reproduce the issue. Please please please link to a demo project if possible, this makes your issue much easier to diagnose (seriously).

Expected result

What should happen?

Actual result

What happened.

Environment

Paste the information here as shown by hyas info

Summary

Brief explanation of the feature.

Basic example

Include a basic example or links here.

Motivation

Why are we doing this? What use cases does it support? What is the expected outcome?

Resources

• WebP
• Serving AVIF Images
• AVIF Converter
• WebP and AVIF images on a Hugo website
• How to Use AVIF: The New Next-Gen Image Compression Format

Summary

Brief explanation of the update.

@h-enk In your tutorial here, you need to mention that docs/overview/_index.md also has to be created. Otherwise, the new page does not appear in the docs menu.

thuliteio/doks#715 (comment)

Rough draft

Include a rough draft or links here.

Motivation

Why are we doing this? What use cases does it support? What is the expected outcome?

Summary

Brief explanation of the feature.

Basic example

Include a basic example or links here.

• prefers-color-scheme

Motivation

Why are we doing this? What use cases does it support? What is the expected outcome?

Bring the current documentation up to par with the current code base.

Summary

Brief explanation of the feature.

Basic example

Include a basic example or links here.

• https://gridsome.org/starters/

Motivation

Why are we doing this? What use cases does it support? What is the expected outcome?

Discussed in thuliteio/doks#1166

<div class="table-responsive">
    {{ $htmlTable := .Inner | markdownify }}
    {{ $class := .Get 0 | default "" }}
    {{ $old := "<table>" }}
    {{ $new := printf "<table class=\"%s\">" $class }}
    {{ $htmlTable := replace $htmlTable $old $new }}
    {{ $htmlTable | safeHTML }}
</div>

{{< bootstrap-table "table table-striped table-bordered" >}}
| Animal  | Sounds |
|---------|--------|
| Cat     | Meow   |
| Dog     | Woof   |
| Cricket | Chirp  |
{{< /bootstrap-table >}}
```</div>

Dear Sir,

last year I created two tiny pages with your great Doks Hugo theme in version 0.5. Recently I discovered that now finally versions 1.x are available, so I just tried creating a new project from scratch -- when it should finally succeed, I might transfer my existing text files and upgrade the pages.

Two initial remarks, in case you are interested in improving your website with the instructions:

https://getdoks.org/docs/start-here/getting-started/

npm create hyas@latest -- --template doks

For people like me, not evolved with professional web development, it might not be that obvious that this command is interactive and will ask for the actual project name. Please consider adding a hint -- I was tempted to replace doks with my actual project name.

The next point is much more important:

npm install

started for me with some animations and displaying timings, but then stalled for minutes. I finally pressed some CTRL codes in the terminal after four minutes without visible changes, and tried again. Again same behaviour. And my Internet connection is typically very fast! This time I let it running, while using the web browser to see if I could use other packages managers on my Gentoo Linux box. Then finally, after more than 8 minutes, it finished successfully:

$ npm create hyas@latest -- --template doks
✔ Project name: … nimprogramming.com

Scaffolding project in /home/salewski/nimprogramming.com...

Done. Now run:

  cd nimprogramming.com
  npm install
  npm run dev

salewski@hx90 ~ $ cd nimprogramming.com
salewski@hx90 ~/nimprogramming.com $ npm install

> [email protected] postinstall
> hugo-installer --version otherDependencies.hugo --extended --destination node_modules/.bin/hugo


Hugo Installer

> Checking for existing binary
> Downloading binary from "https://github.com/gohugoio/hugo/releases/download/v0.123.7/hugo_extended_0.123.7_Linux-64bit.tar.gz"
> Downloading checksum from "https://github.com/gohugoio/hugo/releases/download/v0.123.7/hugo_0.123.7_checksums.txt"
> Verifying binary checksum
> Extracting binary to disk
> Verifying binary health

Hugo is now available in "node_modules/.bin/hugo".

- Version       0.123.7
- Extended      Yes
- OS            linux
- Architecture  x64

hugo v0.123.7-312735366b20d64bd61bff8627f593749f86c964+extended linux/amd64 BuildDate=2024-03-01T16:16:06Z VendorInfo=gohugoio

Success!

added 414 packages in 8m

60 packages are looking for funding
  run `npm fund` for details

So please consider adding a hint that this action can take very long!

Best regards,

Dr. Stefan Salewski

Is this released?

I wanted to know how to update doks, so went here. But the page talks about updating the dependent node modules. Where do I find how to update doks itself?

Originally posted by @vivekragunathan in thuliteio/doks#584 (comment)

Summary

See Motivation.

Basic example

• NPM package
• plausible/plausible-tracker
• plausible-tracker

Motivation

Add missing data adblockers by using NPM package as an alternative to proxy. See also: Adblockers and using a proxy for analytics

Summary

Brief explanation of the feature.

thuliteio/doks#227 (comment)

Basic example

Include a basic example or links here.

Motivation

Why are we doing this? What use cases does it support? What is the expected outcome?

Description

Page with no search id causes console error when event listener is triggered. See also lines 13..23 of ./assets/js/app.js.

Steps to reproduce

1. Go to https://getdoks.org/
2. Hit Ctrl + /
3. Check console log:

Expected result

What should happen?

Actual result

What happened.

Environment

Paste the information here as shown by hyas info

Description

Trying to follow instructions on Windows, but when got to npm run dev received this error:

> exec-bin node_modules/.bin/hugo/hugo server --bind=0.0.0.0 --disableFastRender --baseURL=http://localhost --noHTTPCache

'exec-bin' is not recognized as an internal or external command,
operable program or batch file.

Seems like it's trying to run a linux command instead of whatever the Windows equivalent should be? I already have hugo installed via winget.

Steps to reproduce

1. Opened terminal (Windows PowerShell or cmd)
2. Create a new directory
3. Open https://getdoks.org/docs/start-here/getting-started/
4. ran npm create hyas@latest -- --template doks gave it a project name and the default package name
5. ran npm run dev see error

Expected result

Build site

Actual result

Error

Environment

Windows 10 22H2
Paste the information here as shown by npm run info

> npm version

{
  project: '0.0.0',
  npm: '10.2.3',
  node: '20.10.0',
  acorn: '8.10.0',
  ada: '2.7.2',
  ares: '1.20.1',
  base64: '0.5.0',
  brotli: '1.0.9',
  cjs_module_lexer: '1.2.2',
  cldr: '43.1',
  icu: '73.2',
  llhttp: '8.1.1',
  modules: '115',
  napi: '9',
  nghttp2: '1.57.0',
  nghttp3: '0.7.0',
  ngtcp2: '0.8.1',
  openssl: '3.0.12+quic',
  simdutf: '3.2.18',
  tz: '2023c',
  undici: '5.26.4',
  unicode: '15.0',
  uv: '1.46.0',
  uvwasi: '0.0.19',
  v8: '11.3.244.8-node.25',
  zlib: '1.2.13.1-motley'
}

> npm list

npm ERR! code ELSPROBLEMS
npm ERR! missing: @hyas/doks-core@^1.2.0, required by [email protected]
[email protected] I:\code\project
`-- UNMET DEPENDENCY @hyas/doks-core@^1.2.0

Looks like maybe some other step is missing?

Summary

Add https://passkeys.dev/ to to showcase.

Congrats @h-enk ! Great efforts in maintaining Doks.

Summary

Brief explanation of the feature.

Basic example

Include a basic example or links here.

• Placeholders

Motivation

Why are we doing this? What use cases does it support? What is the expected outcome?

Summary

Brief explanation of the feature.

• Versioned Content
• Multilingual Mode
• KaTeX
• Mermaid
• Google Fonts

Basic example

Include a basic example or links here.

Motivation

Why are we doing this? What use cases does it support? What is the expected outcome?

• Multilingual Mode Demo
• Versioned Documentation Demo
• Google Fonts

Discussed in thuliteio/doks#492

npm run clean   
npm run server

/* jost-regular - latin */
@font-face {
  font-family: "Roboto";
  font-style: normal;
  font-weight: 400;
  font-display: swap;
  src:
    local("Roboto"),
    url("fonts/vendor/Roboto/Roboto-Regular.ttf") format("ttf");
}

/* jost-500 - latin */
@font-face {
  font-family: "Roboto";
  font-style: normal;
  font-weight: 500;
  font-display: swap;
  src:
    local("Roboto"),
    url("fonts/vendor/Roboto/Roboto-Medium.ttf") format("ttf");
}

/* jost-700 - latin */
@font-face {
  font-family: "Roboto";
  font-style: normal;
  font-weight: 700;
  font-display: swap;
  src:
    local("Roboto"),
    url("fonts/vendor/Roboto/Roboto-Bold.ttf") format("ttf");
}

/* jost-italic - latin */
@font-face {
  font-family: "Roboto";
  font-style: italic;
  font-weight: 400;
  font-display: swap;
  src:
    local("Roboto"),
    url("fonts/vendor/Roboto/Roboto-Italic.ttf") format("ttf");
}

/* jost-500italic - latin */
@font-face {
  font-family: "Roboto";
  font-style: italic;
  font-weight: 500;
  font-display: swap;
  src:
    local("Roboto"),
    url("fonts/vendor/Roboto/Roboto-MediumItalic.ttf") format("ttf");
}

/* jost-700italic - latin */
@font-face {
  font-family: "Roboto";
  font-style: italic;
  font-weight: 700;
  font-display: swap;
  src: local("Roboto"), url("fonts/vendor/Roboto/Roboto-BoldItalic.ttf") format("ttf");
}
...
```</div>

Summary

Brief explanation of the update.

• What do you like most about Doks?
• What do you like the least about Doks?
• Test interest in sub navigation menus (main + docs)
• Test interest in auto generated menus (main + docs)
• Test interest in updated blog pages (list + single)
• Test interest in Doks CMS

Rough draft

Include a rough draft or links here.

Motivation

Why are we doing this? What use cases does it support? What is the expected outcome?

Description

The Frontmatter link on this section leads to a 404
https://getdoks.org/docs/start-here/getting-started/#frontmatter

Steps to reproduce

Click on the "common set of frontmatter properties" link

Expected result

Redirected to a non dead link for frontmatter reference

Actual result

404 occured to https://getdoks.org/reference/frontmatter/

Environment

Actual website, so production?

Description

Describe the issue that you're seeing.

• On this page links / TOC links are shown
• Page structure / <h1> element not shown

Steps to reproduce

Clear steps describing how to reproduce the issue. Please please please link to a demo project if possible, this makes your issue much easier to diagnose (seriously).

Expected result

What should happen?

Actual result

What happened.

Environment

Paste the information here as shown by hyas info

Summary

• Post on getdoks.org
• Post on Open Collective
• Post on Discussions
• Send out newsletter update
• Post on Twitter
• Post on Hacker News

Rough draft

Include a rough draft or links here.

• Help Doks grow further by supporting us on Open Collective. Thanks!

Motivation

Why are we doing this? What use cases does it support? What is the expected outcome?

876ad1ccc992ebfce224fdac25e0470066187fd8

Note that (to be documented), identifier needs to be unique. However (unfortunately), can't use .Parent for this.

Example ./archetypes/docs.md

---
title: "{{ replace .Name "-" " " | title }}"
description: ""
lead: ""
date: {{ .Date }}
lastmod: {{ .Date }}
draft: true
images: []
menu:
  docs:
    parent: ""
    identifier: "{{ .Name }}"
weight: 999
toc: true
---

See also:

• Page variables for Identifier and Name ignored
• Section Variables and Methods

Originally posted by @h-enk in thuliteio/doks#806 (comment)