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

Function listing should support anchors/back history #7

Open
mcclure opened this issue Mar 20, 2023 · 2 comments
Open

Function listing should support anchors/back history #7

mcclure opened this issue Mar 20, 2023 · 2 comments

Comments

@mcclure
Copy link

mcclure commented Mar 20, 2023

Since 0.16 or so the lovr-docs repo has listed functions with more than one legal overload with this javascript picker at the top:

https://lovr.org/docs/v0.16.0/lovr.graphics.newBuffer

I love this, before I kept tripping myself up not noticing overloads lower in the file and the new design is clean and convenient.

There is one problem. Because all the overloads are in one page, it doesn't seem to be possible to link to a single one anymore. this is sometimes inconvenient.

IMO, clicking one of the overloads should use JavaScript to set the #anchor (so that links to the current overload can be copied) and set javascript document.history. I have worked with this JS API before and would be happy to implement this change myself if you could point me to how/where the overload directory is set (in a script in this repo? in an external tool?)

@mcclure mcclure changed the title Function listing should support Function listing should support anchors/back history Mar 20, 2023
@bjornbytes
Copy link
Owner

bjornbytes commented Mar 20, 2023

Yes, I really want to add this but wasn't immediately able to figure it out while implementing it.

It uses a CSS-only tab system implemented via radio buttons. The JS is in js/docs.js in that repo.

@mcclure
Copy link
Author

mcclure commented Mar 20, 2023

I'll take a look at it. Thanks.

@bjornbytes bjornbytes transferred this issue from bjornbytes/lovr-docs Jun 26, 2024
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

No branches or pull requests

2 participants