olivernn / lunr.js

A bit like Solr, but much smaller and not as bright
http://lunrjs.com
MIT License
8.96k stars 548 forks source link

Fixes for Incorrect Sidebar Links #20

Closed DannyNemer closed 11 years ago

DannyNemer commented 11 years ago

Functions with the same name had the same id. For example, lunr.Pipeline.load(), lunr.SortedSet.load(), lunr.Index.load(), etc., all had id='load', so every href='#load' link in the sidebar jumped to lunr.Pipeline.load(), because it was the first id='load' on the page. These changes give every identically named function a unique id, such as, #Pipeline-load, #SortedSet-load, and #Index-load, so that the sidebar behaves correctly.

olivernn commented 11 years ago

Thanks a lot for taking a look at this. The docs are actually auto generated using olivernn/dox-template and visionmedia/dox so any changes to the docs/index.html will be overwritten the next time the docs are generated unfortunately.

If you wanted to take a look at a fix for this the best place to start is with olivernn/dox-template and see if you can change the way the template generates the html. Feel free to open an issue (or even better a pull request!) over there and I'll try and find some time to look at it.