googleapis / jsdoc-fresh

A clean, responsive documentation template with search and navigation highlighting for JSDoc 3.
Apache License 2.0
14 stars 10 forks source link

fix: prevent identically named top-level items in the left nav #5

Closed hegemonic closed 5 years ago

hegemonic commented 5 years ago

Before this change, if two top-level items had the same name, that name appeared twice in the left nav. For example, v1.Foo and v2.Foo both appeared as Foo, and the generated HTML used the id attribute Foo-nav for both items.

After this change, the left nav shows v1.Foo and v2.Foo instead, and their id attributes are v1.Foo-nav and v2.Foo-nav, respectively.

This issue was originally observed in the Cloud Tasks docs. I tested the fix with googleapis/nodejs-tasks and confirmed that it fixed the issue.

hegemonic commented 5 years ago

@bcoe FYI

JustinBeckwith commented 5 years ago

:tada: This PR is included in version 1.0.2 :tada:

The release is available on:

Your semantic-release bot :package::rocket: