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

Better Table of Contents #153

Open
rcherny opened this issue Aug 26, 2015 · 3 comments
Open

Better Table of Contents #153

rcherny opened this issue Aug 26, 2015 · 3 comments

Comments

@rcherny
Copy link
Contributor

rcherny commented Aug 26, 2015

I think we may need a better Table of Contents system. Thoughts include:

  • the sections are big enough that the headers to a lower level might be useful
  • the current side TOC obviously won't suffice
  • a scrollspy type UI (Track the menu location against the scroll #148) or
  • section by section being 'sticky' (e.g. CSS stays at top in CSS section) might be useful
@rcherny
Copy link
Contributor Author

rcherny commented Aug 26, 2015

Our current TOC is generated by JavaScript when the page is loaded. However, we could probably generate the TOC from the Markdown during the build with something like:

https://github.com/jonschlinkert/markdown-toc

@roblarsen
Copy link
Contributor

Serving static HTML FTW.

@rcherny
Copy link
Contributor Author

rcherny commented Aug 26, 2015

Yeah. Never liked that approach but our build wasn't smart enough. Now it can be.

@rcherny rcherny added this to the Standards.Current milestone Aug 26, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants