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

Jcardonadcdev/issue25 add modules to nav #1

Merged

Conversation

russaa
Copy link

@russaa russaa commented Aug 2, 2019

see davidshimjs#45
see davidshimjs#25


This PR is to fix one existing issue, one issue I found while working with a recent version of jsdoc, one change to the display of items in the navigation list, and one change to display markdown lists in class descriptions as bulleted lists.

* The existing issue is #25, modules tagged with `@module` do not get added to the navigation list on the left side of the page. In reference to this issue I made the following changes:
  
  * Added a new `if` statement to the `publish.buildNav` method to add modules to the array of items that get added to the navigation list
  * Removed `module:` from the name of the navigation item so the display name shown in the list is easier to read.

* I found an issue when using the most recent version of _jsdoc_ (3.4.2) that gets bundled with the latest version of _grunt-jsdoc_ (2.1.0). The `<li>` elements generated for AMD modules in the navigation list have the wrong `data-name` attribute value due to a new file naming method in recent versions of _jsdoc_.
  
  * The fix is to set the `data-name` attribute of the element to the file name generated generated for the module instead of setting it to the `longname` property.

* I added some entries to `main.less` to render `<li>` elements in class descriptions with `list-style-type:disc`

* The last change is to add section labels to the navigation list so that it is easy to see the items grouped by type. This is the way that the default template for jsdoc displays items in the navigation list.

Added an if statement in buildNav method to add modules and added a sample
file
In recent version of jsdoc, amd module file names changed; this commit fixes data-name page-name mismatch causing problem with displaying memebers in navigation panel
@russaa russaa merged commit 1807249 into mmig:patched Aug 2, 2019
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.

2 participants