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

Typo inside the jsdoc example #103

Closed
maxime-bc opened this issue Jun 16, 2022 · 0 comments · Fixed by #104
Closed

Typo inside the jsdoc example #103

maxime-bc opened this issue Jun 16, 2022 · 0 comments · Fixed by #104

Comments

@maxime-bc
Copy link
Contributor

maxime-bc commented Jun 16, 2022

Describe the bug

There is a typo inside the "Example JSDoc Config" section in the README.

The markdown object is a child of the opts object, but in the jsdoc-config.json the markdown object is a child of the root object.

As a result, when using the "Example JSDoc Config", links inside the "On this page" section referring to the README content don't work.

Steps to reproduce the behavior:

Use the "Example JSDoc Config".

Expected behavior

Links inside the "On this page" section referring to the README file should work.

Desktop :
OS: Rocky Linux 8.6
Browsers : Firefox 101.0.1, Chrome 102.0.5005.115

Additional context :
jsdoc version : 3.6.10
clean-jsdoc-theme version : 4.0.5

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant