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

How turn on the "on this page" TOC #289

Open
talwgx opened this issue May 25, 2024 · 2 comments
Open

How turn on the "on this page" TOC #289

talwgx opened this issue May 25, 2024 · 2 comments
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@talwgx
Copy link

talwgx commented May 25, 2024

UPDATE: It was only after I read #231 That I understood that on my Mac laptop, the TOC was indeed being rendered, but the screen was not enough to show it. I do believe issue #231 is important as w/o reading it, I would have never known as a user that a right-hand side TOC was even being rendered , which it was and only became visible when I zoomed Chrome out to 75%. Here are screenshots:

75% resolution

75%

80% and up:

80%

Original:

In this demo image, the table-of-contents is turned on the right, but on the actual demo page it is not, and that is also the behavior I see when I run jsdoc+clean locally on either my code or the demo code. I'm sure I'm missing something obvious, but I wondered if/how you turn on the right side "on this page" TOC for this template? I apologize for the basic question and very much appreciate the help!

Copy link

Wonderful, you have created your first issue for clean-jsdoc-theme. Someone will talk to you soon!

@talwgx talwgx changed the title Turning on the "on this page" TOC How turn on the "on this page" TOC May 25, 2024
@ankitskvmdam
Copy link
Owner

Hi @talwgx

Thanks for raising this issue again. I do believe it is an important feature. What we can do is, instead of having it on the right side, on small screen devices we can have it at the top of the page, or any other relevant position. However, I am not able to get time to implement this feature.

I would really love if someone would implement this.

@ankitskvmdam ankitskvmdam added enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers labels Jun 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants