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

Fix the example jsdoc config in README.md #104

Merged
merged 1 commit into from
Jun 17, 2022
Merged

Fix the example jsdoc config in README.md #104

merged 1 commit into from
Jun 17, 2022

Conversation

maxime-bc
Copy link
Contributor

@maxime-bc maxime-bc commented Jun 16, 2022

Description

Fixes #103 : in the jsdoc config example of the README, the markdown object is a child of the opts object.

The use of this jsdoc configuration causes links inside the "On this page" section referring to the README content to not work properly.

As seen inside the file jsdoc-config.json, the markdown object should be a child of the root object.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update
  • Other (if so, then explain below briefly)

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's Amazing! Thanks for creating your first PR for clean-jsdoc-theme. Someone will review it soon!

@ankitskvmdam
Copy link
Owner

Thanks for the PR!

@ankitskvmdam ankitskvmdam merged commit 60daf7c into ankitskvmdam:master Jun 17, 2022
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 this pull request may close these issues.

Typo inside the jsdoc example
2 participants