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

Adjustments for RHS TOC #133

Open
mmcky opened this issue May 28, 2021 · 4 comments · May be fixed by #144
Open

Adjustments for RHS TOC #133

mmcky opened this issue May 28, 2021 · 4 comments · May be fixed by #144
Assignees
Labels
enhancement New feature or request

Comments

@mmcky
Copy link
Contributor

mmcky commented May 28, 2021

QuantEcon/lecture-datascience.myst#119

@DrDrij thoughts?

@DrDrij
Copy link
Member

DrDrij commented May 28, 2021

@mmcky I reckon it's pretty useful functionality. Almost like the minimap in code editors. I'd be happy to implement.
This would include:

  • Make the whole in-page-toc sticky (not just 'back to top')
  • Add active highlight to toc items depending on page scroll

@mmcky
Copy link
Contributor Author

mmcky commented May 28, 2021

Yeah it is pretty good. Now that we are inheriting from sphinx-book-theme are we just overriding the styles? Or do we need to implement this in our context?

@DrDrij
Copy link
Member

DrDrij commented May 28, 2021

I'll take a closer look. There might be a tiny little work to refactor the markup so that it can use the JS/CSS from SBT.
Hopefully as you have suggested all we'll need then is some QBT styling.
@mmcky Shall we go ahead and implement this across the quantecon-book-theme sites?

@mmcky
Copy link
Contributor Author

mmcky commented May 28, 2021

Yeah let's see what it looks like. I think the animation and navigation is nice but John might like the simplicity of what we have. So let's make a PR and get comments :-)

We could always have a simple-contents-toc=True/False flag

@mmcky mmcky changed the title Datascience Theme Comments Adjustments for RHS TOC Jun 2, 2021
@mmcky mmcky added the enhancement New feature or request label Jun 2, 2021
@mmcky mmcky added this to the future milestone Jun 2, 2021
@DrDrij DrDrij linked a pull request Jun 6, 2021 that will close this issue
2 tasks
@mmcky mmcky removed this from the future milestone Mar 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants