colinwilson / lotusdocs Goto Github PK

📖 A free, lightweight, modern documentation theme for Hugo [WIP]

License: MIT License

HTML 11.25% JavaScript 66.55% SCSS 22.20%

hugo hugo-site vercel lotus-docs hugo-docs-theme hugo-theme jamstack responsive bootstrap5 documentation-theme hugo-documentation documentation documentation-generator

lotusdocs's Issues

Create an example repo to showcase the more advanced features of Lotus Docs

The exampleSite folder provides a basic example of Lotus Docs.

Create a separate repo (Starter Theme) to showcase features such as DocSearch integration and Vercel deployment

Unable to Build from Quickstart Page (March 1st, 2024)

Past Issues Searched

I have searched open and closed issues to make sure that the bug has not yet been reported

Issue is a Bug Report

This is a bug report and not a feature request, nor asking for support

Describe the bug

Complete Newbie to Hugo so this may be a mistake on my part.

Followed the instructions from the Quickstart Guide.

High Level Overview:

Installed Hugo & Go.
a. go version = go1.22.0 linux/amd64
b. hugo version = hugo v0.92.2+extended linux/amd64 BuildDate=2023-01-31T11:11:57Z VendorInfo=ubuntu:0.92.2-1ubuntu0.1
Use Hugo to make a new site & cd into said directory.
Initialized project (site) as a Module as a Git Rep.
a. module git.repo.........................................................
go 1.22.0
require (
github.com/colinwilson/lotusdocs v0.1.0 // indirect
github.com/gohugoio/hugo-mod-bootstrap-scss/v5 v5.20300.20200 // indirect
)
Add Lotus Docs as a Module to Project (site).
Create new Content (Example Page). Note: Please let me know if I should not be sharing the full text of the below; AKA, Cipher text.
github.com/colinwilson/lotusdocs v0.1.0 h1:oTC8pAYQp9XDNaUwE4SEY+id3ByNELxIIFrktYEGxYA=
github.com/colinwilson/lotusdocs v0.1.0/go.mod h1:9zu2REJDi+zdPRcR5/bRYSUR7gkNF4NQLvV38SEoCP8=
github.com/gohugoio/hugo-mod-bootstrap-scss/v5 v5.20300.20200 h1:SmpwwN3DNzJWbV+IT8gaFu07ENUFpCvKou5BHYUKuVs=
github.com/gohugoio/hugo-mod-bootstrap-scss/v5 v5.20300.20200/go.mod h1:kx8MBj9T7SFR8ZClWvKZPmmUxBaltkoXvnWlZZcSnYA=
github.com/gohugoio/hugo-mod-jslibs-dist/popperjs/v2 v2.21100.20000/go.mod h1:mFberT6ZtcchrsDtfvJM7aAH2bDKLdOnruUHl0hlapI=
github.com/twbs/bootstrap v5.3.2+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0=
Pushed code to git repo.
Attempt to run this command: hugo server -D

user@machine:~/Documents/sites/site$ hugo server -D
Start building sites … 
hugo v0.92.2+extended linux/amd64 BuildDate=2023-01-31T11:11:57Z VendorInfo=ubuntu:0.92.2-1ubuntu0.1
WARNING: calling IsSet with unsupported type "invalid" (<nil>) will always return false.
ERROR 2024/03/01 22:34:21 render of "page" failed: execute of template failed: template: docs/single.html:25:44: executing "docs/single.html" at <partial (printf "%s/%s" ($.Scratch.Get "pathName") "breadcrumbs.html") .>: error calling partial: "/tmp/hugo_cache/modules/filecache/modules/pkg/mod/github.com/colinwilson/[email protected]/layouts/partials/docs/breadcrumbs.html:5:55": execute of template failed: template: partials/docs/breadcrumbs.html:5:55: executing "partials/docs/breadcrumbs.html" at <.Ancestors.Reverse>: can't evaluate field Ancestors in type *hugolib.pageState
Error: Error building site: failed to render pages: render of "section" failed: execute of template failed: template: docs/list.html:25:44: executing "docs/list.html" at <partial (printf "%s/%s" ($.Scratch.Get "pathName") "breadcrumbs.html") .>: error calling partial: "/tmp/hugo_cache/modules/filecache/modules/pkg/mod/github.com/colinwilson/[email protected]/layouts/partials/docs/breadcrumbs.html:5:55": execute of template failed: template: partials/docs/breadcrumbs.html:5:55: executing "partials/docs/breadcrumbs.html" at <.Ancestors.Reverse>: can't evaluate field Ancestors in type *hugolib.pageState
Built in 709 ms

Expected behavior

As referenced in this page, a generated page.

Screenshots

No response

Environment

- OS: PopOS
- Browser: N/A
- Browser Version: N/A

Mermaid diagram rendering broken

Past Issues Searched

I have searched open and closed issues to make sure that the bug has not yet been reported

Issue is a Bug Report

This is a bug report and not a feature request, nor asking for support

Describe the bug

I attempted to embed Mermaid diagrams in a markdown page, but the built site fails to render them correctly. They seem to successfully render locally when running via hugo server, but not when built via hugo. I also see Javascript errors related to Mermaid in the browser console.

This issue appears to exist on the published lotusdocs documentation also: https://lotusdocs.dev/docs/features/mermaid/

Expected behavior

The built site to correctly render Mermaid diagrams defined in markdown.

Screenshots

Example of failed rendering & console error on lotus docs page:

Location of console error:

Environment

- OS: MacOS M2 & Android mobile
- Browser: Chrome & Firefox on desktop, Chrome on mobile
- Browser Version: Chrome Version 119.0.6045.159 (Official Build) (arm64)

Make the `edit this page` button more useful

Discussed in #37

^{Originally posted by hugo-sid August 26, 2023}

Current behavior

Clicking on the 'edit this page' button opens the corresponding Markdown file from the most recent commit.

What's the problem

The edit this file option on GitHub is disabled, when it is opened in the above mentioned manner. So, the purpose (allowing one to edit) is not served.

Expected behavior with example

Consider the URL: https://lotusdocs.dev/docs/guides/features/feedback-widget/
Clicking on the 'edit this page' button opens: https://github.com/colinwilson/lotusdocs.dev/blob/9907176ffb06a0c8652386aa9f72668a90d85bdc/content/docs/guides/features/feedback-widget.md/ - edit option is disabled.

It would be better if the 'edit this page' button opens any of the following links:

Kind 1 (blob link): https://github.com/colinwilson/lotusdocs.dev/blob/release/content/docs/guides/features/feedback-widget.md
Kind 2 (edit link): https://github.com/colinwilson/lotusdocs.dev/edit/release/content/docs/guides/features/feedback-widget.md

Example of Kind 1 link

https://gohugo.io/content-management/organization/#url

Example of Kind 2 link

https://developers.cloudflare.com/workers/platform/limits#log-size

Solution

One possible solution (not tested) can be to use:

<a href="{{.Site.Params.ghrepo}}edit/release/content/{{ .Lang }}/{{.File.Path}}">Edit this page</a>

Then in config/_default/params.toml :

## GH repo include trailing slash
ghrepo = "https://github.com/colinwilson/lotusdocs/"

Failed to extract shortcode: shortcode "alert" has no .Inner, yet a closing tag was provided

Past Issues Searched

I have searched open and closed issues to make sure that the bug has not yet been reported

Issue is a Bug Report

This is a bug report and not a feature request, nor asking for support

Describe the bug

Hi!
after the install of LotusDocs theme (manual installation by cloning the theme files), I tried hugo serve and I get an error concerning the alert shortcode.

Here is the shortcode concerned:

{{% alert context="info" %}}
my text
{{% /alert %}}

I wonder if it is not a side effect of the following recent update: `5c59008#diff-83f19c21cf48a204476a2ccf63d323c91bd1310d1f99462e590a4878a2d44846L23

Expected behavior

Shortcode alert is understood by LotusDocs and the hugo serve command run successfully.

Screenshots

No response

Environment

- OS: Linux Mint 21 Vanessa
- Browser: N/A
- Browser Version: N/A

Uncaught DOMException: Failed to execute 'querySelector' on 'Element': '#1-correction' is not a valid selector.

Issue with IDs beginning with numbers e.g. ordered lists.

Uncaught DOMException: Element.querySelector: '#1-correction' is not a valid selector
    findOne \js\src\dom\selector-engine.js:41
    _initializeTargetsAndObservables \js\src\scrollspy.js:211
    refresh \js\src\scrollspy.js:91
    _ScrollSpy \js\src\scrollspy.js:73
    getOrCreateInstance \js\src\base-component.js:65
    <anonymous> \js\src\scrollspy.js:284
    handler \js\src\dom\event-handler.js:98
    addHandler \js\src\dom\event-handler.js:184
    on \js\src\dom\event-handler.js:216
    <anonymous>\js\src\scrollspy.js:282
    <anonymous> bootstrap.js:3649

Environment:

Firefox & Chrome
Bootstrap v5.3.0 alpha 3 + incompatible

Related:

#37858

No copy codeblock for non-prism highlighting

Past Issues Searched

I have searched open and closed issues to make sure that the bug has not yet been reported

Issue is a Bug Report

This is a bug report and not a feature request, nor asking for support

Describe the bug

With params.docs.prism = false set in hugo.toml, no copy codeblock button is present on code blocks.

Expected behavior

A copy codeblock button is present on code blocks when prism = false.

Screenshots

No response

Environment

- OS:
- Browser:
- Browser Version:

Copy codeblock button is stacked above the mobile ToC

The copy code block button (when activated by touch of the code block) appears above the mobile view ToC menu when scrolling.

Create custom 404 pages for both the / and /docs paths

Images do not work

Past Issues Searched

I have searched open and closed issues to make sure that the bug has not yet been reported

Issue is a Bug Report

This is a bug report and not a feature request, nor asking for support

Describe the bug

Images do not work in .md files. Local images are not displayed at all and url images (external) crash the site.

Expected behavior

Images are displayed as per the markdown specs.

Screenshots

No response

Environment

- OS:
- Browser:
- Browser Version:

Hardcoded language grammar path in PrismJS autoloader config results in 404s

Past Issues Searched

I have searched open and closed issues to make sure that the bug has not yet been reported

Issue is a Bug Report

This is a bug report and not a feature request, nor asking for support

Describe the bug

See discussion #77 (comment)

The hardcoded PrismJS autoloader plugin language path causes 404 errors if a Hugo project is deployed in a path other than root.

Expected behavior

The PrismJS autoloader should find language grammars regardless of the site's baseURL

Screenshots

No response

Environment

- OS: Windows 11
- Browser: FireFox / Chrome
- Browser Version: 116

Scrolling in FlexSearch

Hello,

loving the theme!

However, FlexSearch results are not scroll-able and they very often overflow outside the screen. Is there a way to add a maximum height to the suggestions container with scrolling?

Thanks for the help!

Links defined by the 'ref' shortcode are incompatible with the link preview tooltip feature

Past Issues Searched

I have searched open and closed issues to make sure that the bug has not yet been reported

Issue is a Bug Report

This is a bug report and not a feature request, nor asking for support

Describe the bug

Internal links defined by the ref shortcode are not compatible with the internal link preview tooltip feature.

ref returns the absolute permalink to a page.

Expected behavior

Either:

The render-link.html markdown render hook is updated to accommodate the ref shortcode

The limitation is documented in How to format internal links for preview tooltips | Lotus Docs

Screenshots

No response

Environment

- OS: Windows 11
- Browser: Firefox / Chrome
- Browser Version: 116

Text in code ticks does not show up as a link

Past Issues Searched

I have searched open and closed issues to make sure that the bug has not yet been reported

Issue is a Bug Report

This is a bug report and not a feature request, nor asking for support

Describe the bug

When embedding a link in code ticks, the link will show up as code, but not as a link.

Sample code:

[`mylink`](www.example.com)

Output:

If we add more text to the link, the text will display as a link, but the text in code ticks will not

Expected behavior

Text in code ticks should display with mono font, but still be colored as a link.

Screenshots

No response

Environment

- OS: MacOS
- Browser: Chrome
- Browser Version: 116

[SECURITY] Cross-Site Scripting (XSS) Vulnerability in Template

Past Issues Searched

I have searched open and closed issues to make sure that the bug has not yet been reported

Issue is a Bug Report

This is a bug report and not a feature request, nor asking for support

Describe the bug

Hello,

I have identified a cross-site scripting (XSS) vulnerability in your Hugo template. Attackers can exploit this vulnerability by injecting code similar to <a href="javascript:alert('XSS')">Click me</a> into the search box.

Vulnerability Description:

Vulnerability Type: Cross-Site Scripting (XSS)
Affected Area: Search box
Attack Scenario: Attackers can insert malicious code into the search box, which gets executed when users visit the search results page.

Please address this issue as soon as possible to enhance the security of your template. Thank you for your attention！

Expected behavior

When a user inputs any code or script into the search box, it should be treated as plain text and displayed as such in the search results page. The code or script should not be executed or interpreted as HTML or JavaScript. This ensures that the search functionality remains secure and prevents any potential cross-site scripting (XSS) attacks.

Screenshots

No response

Environment

- OS: Win11
- Browser: Google
- Browser Version: 115

Close Sidebar Menu when Clicked Outside

Close the sidebar menu when a click occurs outside the element (excluding the close-sidebar element/button).

KaTex equations overflow into ToC on smaller screens

Past Issues Searched

I have searched open and closed issues to make sure that the bug has not yet been reported

Issue is a Bug Report

This is a bug report and not a feature request, nor asking for support

Describe the bug

Large inline KaTex equations overflow into the ToC.

Expected behavior

KaTex equation should be responsive and confined to the 'content' section of the page

Screenshots

Environment

- OS: Windows
- Browser: FireFox / Chrome
- Browser Version: 116.03 / 116.0

Cant edit landing page

Past Issues Searched

I have searched open and closed issues to make sure that the bug has not yet been reported

Issue is a Bug Report

This is a bug report and not a feature request, nor asking for support

Describe the bug

I already edit landing.yml on data but its nothing change, i have problem on feature grid and image compare section. I also tried to change enable to false but its still showing them, thank you

Expected behavior

Fix so i can edit landing page and its not being templated again

Screenshots

Environment

- OS: Windows
- Browser: Chrome
- Browser Version: 119

Website Favicon Preview Unavailable on Mobile

Past Issues Searched

I have searched open and closed issues to make sure that the bug has not yet been reported

Issue is a Bug Report

This is a bug report and not a feature request, nor asking for support

Describe the bug

When sharing a website link, the favicon image doesn't appear.

Steps to reproduce:

Type in the below message in WhatsApp (or any internet-based chat application) to see the website's favicon:
https://stackoverflow.com

Typing in the below message doesn't show the favicon:
https://lotusdocs.dev

Steps to solve:

Having the below files in static/ is likely to make the preview available:

logo.svg                    # could be 512x512 or better
favicon.png                 # 32x32
favicon.ico                 # 32x32
apple-touch-icon.png        # 180x180
icon512.png                 # 512x512

Expected behavior

For the favicon to be displayed when sending a message containing the link to the website.

Alerts are not indented when used in lists

Past Issues Searched

I have searched open and closed issues to make sure that the bug has not yet been reported

Issue is a Bug Report

This is a bug report and not a feature request, nor asking for support

Describe the bug

When using the alert shortcode within an ordered list, the alert is not getting indented, but instead gets left aligned. Because of that, the numbering within the ordered list is off.

Example code:

This is a test command.

kubectl apply -f- <<EOF
apiversion: v1
test: value 
EOF

This is the second command.
```
kubectl get pods 
```
{{% alert icon="🍅" context="success" %}}
This is an alert that should be indented.
{{% /alert %}}
Test
{{% alert icon="🍅" context="success" %}}
Another alert.
{{% /alert %}}

It will display as follows:

Expected behavior

Indent alerts when they are placed within an ordered list.

Screenshots

No response

Environment

- OS: macOS
- Browser: Chrome
- Browser Version: 116

CJK language search does not work in flexsearch

Past Issues Searched

I have searched open and closed issues to make sure that the bug has not yet been reported

Issue is a Bug Report

This is a bug report and not a feature request, nor asking for support

Describe the bug

Searching for English words works fine, but searching for words in CJK languages yields no results.

Expected behavior

should be able to enter words from CJK languages as well as English words and still get search results.

Screenshots

Environment

- OS: Windows 11
- Browser: Chrome
- Browser Version: 112

Shortcode tables don't show up within tabs

Past Issues Searched

I have searched open and closed issues to make sure that the bug has not yet been reported

Issue is a Bug Report

This is a bug report and not a feature request, nor asking for support

Describe the bug

I tried to create a table using the shortcode tables within a tab and it doesn't appear:

{{< tabs tabTotal="2">}}
{{% tab tabName="Example" %}}

{{< table >}}
| Animal | Sounds | Legs |
|---------|--------|-----|
| `Cat` | Meow | 4 |
| `Dog` | Woof | 4 |
| `Cricket` | Chirp | 6 |
{{< /table >}}

{{% /tab %}}
{{% tab tabName="Another Tab" %}}

{{< table "table-hover" >}}
| Animal | Sounds | Legs |
|---------|--------|-----|
| `Cat` | Meow | 4 |
| `Dog` | Woof | 4 |
| `Cricket` | Chirp | 6 |
{{< /table >}}

{{% /tab %}}
{{< /tabs >}}

Normal tables appear just fine.

Expected behavior

I'd expect the shortcode tables to appear within the tabs.

Screenshots

No response

Environment

- OS: Windows
- Browser: Brave | Chrome
- Browser Version: v1.63.169 | v122.0.6261.112

Code Highlighting Doesn't Work Properly on Desktop Browsers

Past Issues Searched

I have searched open and closed issues to make sure that the bug has not yet been reported

Issue is a Bug Report

This is a bug report and not a feature request, nor asking for support

Describe the bug

Code blocks containing highlighted lines don't render on desktop browsers. I've tested this with Firefox and Chrome (without addons and also in private mode).

Additionally, if a wide code block is viewed on a smaller screen, horizontal scrollbar appears between the code text and code margin.

It works properly in mobile browsers.

Example this link renders differently on desktop and mobile.

The website is deployed on an NGINX server. Except for the automatic LetsEncrypt setup, the config file is at a bare minimum (happy to share if needed).

Expected behavior

Code blocks to be highlighted on desktop browsers.
Horizontal lines to appear at the margin instead of above it.

Screenshots

Desktop browsers will smaller screen:

Desktop browsers will smaller screen:

Common to all desktop browsers

Environment

No response

Alerts lose color in light mode

Past Issues Searched

I have searched open and closed issues to make sure that the bug has not yet been reported

Issue is a Bug Report

This is a bug report and not a feature request, nor asking for support

Describe the bug

Alert boxes lose their color in light mode.

Expected behavior

Alert boxes should have similar color in both dark and light modes.

Screenshots

Environment

- OS: Ubuntu
- Browser: Brave, Firefox
- Browser Version: Brave v1.57.53, Firefox 116.0.3

How can i edit the landing page?

Past Issues Searched

I have searched open and closed issues to make sure that the bug has not yet been reported

Issue is a Bug Report

This is a bug report and not a feature request, nor asking for support

Describe the bug

How can i edit the landing page?

Expected behavior

i guess it should be possible to edit it, and it should be documented to

Screenshots

No response

Environment

- OS: Debian 12.2
- Browser: Edge
- Browser Version: 116

Prism inside Tabs Issue

Past Issues Searched

I have searched open and closed issues to make sure that the bug has not yet been reported

Issue is a Bug Report

This is a bug report and not a feature request, nor asking for support

Describe the bug

I was writing a guide and after inserting prism into tabs the post no longer displays anything.
Apparently I can't use prism inside tabs.

Expected behavior

that prism works inside tabs

Screenshots

No response

Environment

- OS: win11
- Browser: ff
- Browser Version: latest

Update the ToC UI to support mobile viewing

There's currently no Toc (Table of Contents) when browsing docs on mobile. A ToC (specifically in mobile view) would make navigating pages with a large number of headings (<h1>,<h2>,<h3>) much easier.

Create a mobile ready, sticky, drop down ToC

在iPhone上显示有问题

在iPhone上显示有问题， "返回顶部"按钮异常

PrismJS highlight color no applied with shell

Past Issues Searched

I have searched open and closed issues to make sure that the bug has not yet been reported

Issue is a Bug Report

This is a bug report and not a feature request, nor asking for support

Describe the bug

When I use Markdown shell syntax, the highlight color doesn't apply, but when I apply HTML, it seems to work.

sudo apt update

sudo apt install python3-pip -y
pip3 install --upgrade pip
pip3 install python-openstackclient python-novaclient python-swiftclient

openstack --help
nova help

<html>
  <head>
    <title>Buy cool new product</title>
  </head>
  <body>
    <!-- Use action="/create-checkout-session.php" if your server is PHP based. -->
    <form action="/create-checkout-session" method="POST">
      <button type="submit">Checkout</button>
    </form>
  </body>
</html>

Expected behavior

I expected highlight color applied like here : https://lotusdocs.dev/docs/quickstart/

Screenshots

Environment

- OS: Windows
- Browser: EDGE
- Browser Version:118.0.2088.46

Landing page issues

Past Issues Searched

I have searched open and closed issues to make sure that the bug has not yet been reported

Issue is a Bug Report

This is a bug report and not a feature request, nor asking for support

Describe the bug

I was trying out the landing.yaml to use it as the landing page for our doc set, and ran into some issues.

Can’t have book icon in upper left to logo and link to main website (e.g., I’m on docs.solo.io and want this to go back to solo.io)
Can’t have the CTA buttons as anchors to content further down the page.
Can’t add anchors to sections further down the page. At least I tried adding yaml fields for anchors and it didn't seem to do anything.
Can’t have more than one feature section for different collections of docs. It errors or only displays one of the feature sections.
In the feature section, can’t click or add a button to go to a page with more info.

Related but different issues:

#116

Expected behavior

See the previous list, which I expected based on common landing page patterns.

Screenshots

No response

Environment

- OS: MacOS
- Browser: brave, chrome, safari
- Browser Version: Brave Version 1.58.137, Chromium: 117.0.5938.153, Safari 16.6

Markdown alerts do not seem to display background color

Past Issues Searched

I have searched open and closed issues to make sure that the bug has not yet been reported

Issue is a Bug Report

This is a bug report and not a feature request, nor asking for support

Describe the bug

HTML alerts display with a background color.

Example code:

{{< alert icon="🍅" context="success" text="HTML alert" />}}

Displays as:

However, when I create a markdown alert, it does not seem to come up with a background color.

Example code:

{{% alert icon="🍅" context="success" %}} 
Markdown 
{{% /alert %}}

Displays as:

I tried the markdown example with the cart icon in your doc as well, but it seems to not show a background color either.

Expected behavior

Have markdown alerts display the selected background color.

Screenshots

No response

Environment

- OS: macOS
- Browser: Chrome
- Browser Version: 116

Add feedback widget feature

Add a simple, configurable feedback widget that can integrate with either Google or Plausible analytics to record visitor feedback on content pages.

Create `exampleSite` folder

Discussed in #3

^{Originally posted by hugo-sid January 14, 2023}
Hi @colinwilson . From the screenshot, lotus docs looks exiting.

Any plans to have the Hugo exampleSite folder ? So, that one can easily check out how to organise content.

Create an exampleSite to demo Lotus Docs' feature set

Publish as Gitlab Pages

Past Issues Searched

I have searched open and closed issues to make sure that the bug has not yet been reported

Issue is a Bug Report

This is a bug report and not a feature request, nor asking for support

Describe the bug

I have a working instance of gitlab with working gitlab-pages. The Plain-HTML Pages is working the hugo template from gitlab isn't working and the Gitlab Hugo Pages Example works but looks weird. But my locally build which works fine locally with lotusdocs completes the CI/CD. I am using GO v1.21.0 but it seems that the latest Hugo-extended uses GO v1.23.0. My Pipeline was running after I switched to hugo-extended:0.109.0.

My Hugo Config is so far the basic one and it works fine locally. The only issue seems that the copying to public or something else isn't working as expected. This is the output of the build and it seems that something is missing:

$ hugo mod get -u $THEME_URL
go: downloading github.com/colinwilson/lotusdocs v0.0.0-20230824022610-a7d660221d18
$ hugo
Start building sites … 
hugo v0.109.0-47b12b83e636224e5e601813ff3e6790c191e371+extended linux/amd64 BuildDate=2022-12-23T10:38:11Z VendorInfo=gohugoio
WARN 2023/08/24 12:11:51 found no layout file for "HTML" for kind "page": You should create a template file which matches Hugo Layouts Lookup Rules for this combination.
WARN 2023/08/24 12:11:51 found no layout file for "HTML" for kind "home": You should create a template file which matches Hugo Layouts Lookup Rules for this combination.
WARN 2023/08/24 12:11:51 found no layout file for "HTML" for kind "term": You should create a template file which matches Hugo Layouts Lookup Rules for this combination.
WARN 2023/08/24 12:11:51 found no layout file for "HTML" for kind "taxonomy": You should create a template file which matches Hugo Layouts Lookup Rules for this combination.
WARN 2023/08/24 12:11:51 found no layout file for "HTML" for kind "section": You should create a template file which matches Hugo Layouts Lookup Rules for this combination.
WARN 2023/08/24 12:11:51 found no layout file for "HTML" for kind "taxonomy": You should create a template file which matches Hugo Layouts Lookup Rules for this combination.
                   | EN  
-------------------+-----
  Pages            |  5  
  Paginator pages  |  0  
  Non-page files   |  0  
  Static files     |  0  
  Processed images |  0  
  Aliases          |  0  
  Sitemaps         |  1  
  Cleaned          |  0  
Total in 15 ms

Sadly I have to little insight to grasp what might cause the issue.

The following is the gitlab CICD:

image: registry.gitlab.com/pages/hugo/hugo_extended:0.109.0

variables:
  HUGO_ENV: production
  THEME_URL: "github.com/colinwilson/lotusdocs"

default:
  tags:
    - docker
    - linux
  before_script:
    - apk add --no-cache go curl bash nodejs
    - hugo mod get -u $THEME_URL
    ## Uncomment the following if you use PostCSS. See https://gohugo.io/hugo-pipes/postcss/
    #- npm install postcss postcss-cli autoprefixer

test:
  tags:
    - docker
    - linux
  script:
    - hugo
  rules:
    - if: $CI_COMMIT_REF_NAME != $CI_DEFAULT_BRANCH

pages:
  tags:
    - docker
    - linux
  script:
    - hugo
  artifacts:
    paths:
      - public
  rules:
    - if: $CI_COMMIT_REF_NAME == $CI_DEFAULT_BRANCH

So at the end I only get 404s.

Expected behavior

With successfull build and deploy I expect a working Pages Site

Screenshots

No response

Environment

- OS: Arch Linux
- Browser: Firefox
- Browser Version: 116

Footer Link Inconsistent with Theme Color

Past Issues Searched

I have searched open and closed issues to make sure that the bug has not yet been reported

Issue is a Bug Report

This is a bug report and not a feature request, nor asking for support

Describe the bug

I'm using the emerald theme and noticed that links in the footer are highlighted differently on different pages.

In localhost:1313/projects/, the footer looks like this by default:

On hovering over the footer link, it is highlighted with a horizontal green line:

And on clicking any of the projects, (url localhost:1313/projects/myproject), the footer link is highlighted correctly (as shown on lotusdocs.dev/docs and its inner links):

Expected behavior

Footer links to be displayed in the theme color on all pages.

Example this page

Screenshots

Screenshots added in description

Environment

- OS:
- Browser:
- Browser Version:

All sidebar submenu items are incorrectly highlighted as active when URL is a parent directory

When the active URL is a submenu directory e.g. https://mysite.com/docs/feature-guide/shortcodes/. The directory's child items are all marked/highlighted as active too (see below).

None of the submenu items should be highlighted e.g.:

themeColor in hugo.toml doesn't affect homepage

Past Issues Searched

I have searched open and closed issues to make sure that the bug has not yet been reported

Issue is a Bug Report

This is a bug report and not a feature request, nor asking for support

Describe the bug

When I change the setting for themeColor in hugo.toml, the accent color on the internal pages changes immediately. However, the accent color (icons, buttons, links) on the homepage (localhost:1313) are still the default blue.

Expected behavior

I expect that the themeColor setting takes effect across the entire site, including the homepage.

Screenshots

No response

Environment

- OS: OSX 13.4.1
- Browser: Firefox
- Browser Version: 118.0.1

Add support for FlexSearch

Add support for FlexSearch (as the default search library)

Prism theme does not show correct CSS when baseURL/publishDir are not set to /

Past Issues Searched

I have searched open and closed issues to make sure that the bug has not yet been reported

Issue is a Bug Report

This is a bug report and not a feature request, nor asking for support

Describe the bug

I am running into an issue when using the Prism themes. It works great locally when my baseURL is set to / and the publishDir are not set. This is the same setup that you have in the hugo.toml file of the exampleSite.

when we push the docs to prod, we need to change the baseURL and set a publishDir. As soon as I do that, the Prism theme does not work properly anymore. I tried it with the exampleSite and seeing the same issue.

This is how it looks like with baseURL = / and no publishDir:

And this is how it looks like with baseURL = https://example.com and publishDir = public/product

Expected behavior

The CSS should be the same in both scenarios

Screenshots

No response

Environment

- OS:
- Browser: Chrome and Firefox
- Browser Version:

"Docs" Not Displayed in Header on Homepage

Past Issues Searched

I have searched open and closed issues to make sure that the bug has not yet been reported

Issue is a Bug Report

This is a bug report and not a feature request, nor asking for support

Describe the bug

Based on this quickstart guide, I created a page in the "docs" section.

The URL http://127.0.0.1:1313/docs works and the page is listed, but the "docs" section is not visible in the homepage http://127.0.0.1:1313.

I'm unable to find information on lotusdocs.dev about configuring the header.

Expected behavior

Docs to be displayed in the header on the homepage.

Screenshots

No response

Environment

- OS:
- Browser:
- Browser Version:

Close Sidebar Menu when Menu Item is Clicked

Automatically close the sidebar menu when a menu item is clicked (excludes drop-down folders/parent directories)

editPage parameter not working

Past Issues Searched

I have searched open and closed issues to make sure that the bug has not yet been reported

Issue is a Bug Report

This is a bug report and not a feature request, nor asking for support

Describe the bug

I have set the following settings in my hugo.toml file

[params.docs]
    darkMode = true
    editPage = true
    lastMod = true

But even if editPage is true there is no edit this page in the bottom of the page.

Expected behavior

Edit this page button to be used. I use the latest version of lotus docs v.0.1.0 and hugo v0.123.8-5fed9c591b694f314e5939548e11cc3dcb79a79c+extended darwin/arm64 BuildDate=2024-03-07T13:14:42Z VendorInfo=brew

Screenshots

Environment

- OS: MacOS
- Browser: Brave browser
- Browser Version: v1.63.169

Nested ordered/ unordered lists do not start at 1

Past Issues Searched

I have searched open and closed issues to make sure that the bug has not yet been reported

Issue is a Bug Report

This is a bug report and not a feature request, nor asking for support

Describe the bug

When using nested lists, such as an ordered list within an ordered list, or an unordered list within an ordered list, the sublists do not display proper bullets/ numbers.

Example 1: Unordered list within ordered list > no bullet points are displayed

Example 2: Ordered list within ordered list > Substeps do not start at 1

Expected behavior

Display unordered lists as bullet points when nested in ordered lists.
Start counting from 1 for ordered lists that are nested in another ordered list.

Screenshots

No response

Environment

- OS: MacOS
- Browser: Chrome
- Browser Version: 116

SVG images do not stay in frame in tabs

Past Issues Searched

I have searched open and closed issues to make sure that the bug has not yet been reported

Issue is a Bug Report

This is a bug report and not a feature request, nor asking for support

Describe the bug

When I add an SVG image within the tab shortcode, the image displays but is running out of the frame. PNGs seem to stay within the frame.

Expected behavior

Have SVG images behave the same as PNG images in a tab.

Screenshots

Environment

- OS: MacOS
- Browser: Chrome
- Browser Version: 116

/robots.txt is missing

Past Issues Searched

I have searched open and closed issues to make sure that the bug has not yet been reported

Issue is a Bug Report

This is a bug report and not a feature request, nor asking for support

Describe the bug

Currently when visiting https://lotusdocs.dev/robots.txt it returns 404 error page.

Expected behavior

In order to improve the SEO it would be helpful for the site to return /robots.txt with following content:

User-agent: *
Disallow:
Sitemap: https://lotusdocs.dev/sitemap.xml

This will allow crawling everything and point the crawlers to the sitemap.xml which is already available.

Source for sitemap not supporting relative urls: https://stackoverflow.com/a/14218476/1337062
Source for allowing everything: https://stackoverflow.com/a/44467157/1337062

Screenshots

No response

Environment

No response

invalid go version '1.21.5': must match format 1.23

Past Issues Searched

I have searched open and closed issues to make sure that the bug has not yet been reported

Issue is a Bug Report

This is a bug report and not a feature request, nor asking for support

Describe the bug

Following the documentation for deployment with github pages, I get the following error:

Wed, 03 Jan 2024 17:23:15 GMT
Run hugo
Wed, 03 Jan 2024 17:23:15 GMT
Wed, 03 Jan 2024 17:23:15 GMT go: errors parsing go.mod:
Wed, 03 Jan 2024 17:23:15 GMT /home/runner/work/kosmeda/kosmeda/go.mod:3: invalid go version '1.21.5': must match format 1.23
Wed, 03 Jan 2024 17:23:15 GMT Total in 472 ms
Wed, 03 Jan 2024 17:23:15 GMT Error: failed to load modules: failed to download modules: failed to execute 'go [mod download -modcacherw]': failed to execute binary "go" with args [mod download -modcacherw]: go: errors parsing go.mod:
Wed, 03 Jan 2024 17:23:15 GMT /home/runner/work/kosmeda/kosmeda/go.mod:3: invalid go version '1.21.5': must match format 1.23
Wed, 03 Jan 2024 17:23:15 GMT *errors.errorString
Wed, 03 Jan 2024 17:23:15 GMT Error: Process completed with exit code 1.

I was able to resolve it by changing the version to 1.23 inside the go.mod file.

Furthermore, there are some identation errors in the hugo.yaml in the documentation. I just used the one provided by hugo.

Expected behavior

Successful deployment to github pages.

Screenshots

No response

Environment

- OS:
- Browser:
- Browser Version:

Disabling landing page

For now, I do this as a quick workaround

Create index.html in layouts folder.

<!DOCTYPE html>
<html>
<head>
    <meta http-equiv="refresh" content="0; url=/docs" />
</head>
<body>
</body>
</html>

This will automatically redirects me to /docs

Originally posted by @midhunmonachan in #147 (comment)

Seems like more people are interested in this feature. I'm not sure if there is a better way to do this

The page does not support inserting images

Past Issues Searched

I have searched open and closed issues to make sure that the bug has not yet been reported

Issue is a Bug Report

This is a bug report and not a feature request, nor asking for support

Describe the bug

It is not possible to insert an image via markdown syntax, via ![](/xxx.webp) After inserting an image, there is only one empty

tag in the page.

Expected behavior

I want to support inserting images via markdown, or shortcode.

Screenshots

No response

Environment

- OS: Windows11
- Browser: Edge
- Browser Version: 123.0.2420.97

AVIF images not working

Past Issues Searched

I have searched open and closed issues to make sure that the bug has not yet been reported

Issue is a Bug Report

This is a bug report and not a feature request, nor asking for support

Describe the bug

If I use AVIF images, I get this error:

Error: error building site: "/home/pedro/Documentos/GitHub/m3upt-lotusdocs/content/docs/intro.md:1:1": "/home/pedro/.cache/hugo_cache/modules/filecache/modules/pkg/mod/github.com/colinwilson/[email protected]/layouts/docs/_markup/render-image.html:18:77": execute of template failed: template: docs/_markup/render-image.html:18:77: executing "docs/_markup/render-image.html" at <.Width>: error calling Width: this method is only available for image resources

Expected behavior

It works fine if I use the JPG format.

Screenshots

No response

Environment

- OS: I use Arch btw
- Browser: Chromium
- Browser Version: latest

Sidebar nav does not correctly display nested dropdowns

Past Issues Searched

I have searched open and closed issues to make sure that the bug has not yet been reported

Issue is a Bug Report

This is a bug report and not a feature request, nor asking for support

Describe the bug

When having nested dropdowns in the left-hand sidebar, the second dropdown displays as a single page as shown in the following image.

Even though Dropdown 2 has topics underneath, these will not be displayed in the nav. But once you click on Dropdown 2, the subtopics will display in the middle panel.

This is my local folder structure

Expected behavior

Properly display nested dropdowns in the left-hand sidebar.

Screenshots

No response

Environment

- OS: MacOS
- Browser: Chrome
- Browser Version: 116