coffeedoc / codo

CoffeeScript API documentation generator. It's like YARD but for CoffeeScript!
Other
624 stars 92 forks source link

Linking to specific file in frames view #213

Closed amw closed 8 years ago

amw commented 9 years ago

I used to use no-frames Codo views in my project's documentation, but decided to embrace your new defaults. I've got one problem with that. When I want to link to specific class documentation I can only link to the no-frames html file. This makes my documentation work in two modes depending on where the guest is coming from. I would like a way of referencing files inside the frame view.

I can still link people directly to the doc/extra/README.md.html no-frames version of my index or to no-frames class html files doc/class/Snapshot.html.

I can link people to the index.html frame-enabled version of my index, but I cannot link them to a frame-enabled class description.

One way to fix this would be to allow links like index.html#class/Snapshot.html. This requires JavaScript to detect anchor ID on first page load and also updating top frame URL on each navigation.