Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing items, broken links in Markdown converted home page #284

Closed
nuxy opened this issue Apr 18, 2024 · 4 comments
Closed

Missing items, broken links in Markdown converted home page #284

nuxy opened this issue Apr 18, 2024 · 4 comments
Assignees
Labels
bug Something isn't working

Comments

@nuxy
Copy link

nuxy commented Apr 18, 2024

Describe the bug

Using the theme provided JSDoc configuration the resulting output contains the following errors:

  1. List item elements are missing the bullet points/ascending counter.

Missing list-item

  1. In the Table of Content links (On this page) the anchor is missing the ID target. Clicking on the link results with console message Empty string passed to getElementById(). Note: This only occurs in the home page.

  2. Theme options don't seem to be honored. For example, the following doesn't update the HTML <title>Home</title>

"theme_opts": {
  "homepageTitle": "Clean JSDoc theme"
}

To Reproduce

Steps to reproduce the behavior:

The issues can be seen here

Expected behavior

The issues listed above do not occur.

Screenshots

If applicable, add screenshots to help explain your problem.

Desktop:

  • Ubuntu 22.04
  • Firefox (125.0.1), Brave (1.65.114)

Additional context

NPM: 10.2.3
Node: v20.11.0
JSDoc: 4.0.2

Copy link

Wonderful, you have created your first issue for clean-jsdoc-theme. Someone will talk to you soon!

@ankitskvmdam ankitskvmdam self-assigned this May 5, 2024
@ankitskvmdam ankitskvmdam added the bug Something isn't working label May 5, 2024
@ankitskvmdam
Copy link
Owner

Hi @nuxy ,

Thanks for creating this issue. I am working on this. Will update you soon.

@ankitskvmdam
Copy link
Owner

@nuxy

  1. No bullet for list items is fixed in v4.3.0
  2. To fix this you need to add the following in you jsdoc config file. For more visit here.
"markdown": {
        "hardwrap": false,
        "idInHeadings": true // <- otherwise no id will be attached to the headings.
    }
  1. homepageTitle will only update the title of the browser's tab when user is viewing the homepage. If you want to update the title of the sidebar then you need to set title.

image

@nuxy
Copy link
Author

nuxy commented Jun 13, 2024

Hi @ankitskvmdam -

Thanks for addressing this so quickly. I have tested the latest release everything works as expected.

Closing this issue.

@nuxy nuxy closed this as completed Jun 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants