php-fig
Add TOC in sidebar for PSRs & PERs
This merge requests add a TOC in the sidebar for all PSRs & PERs (see #320)
The TOC is generated from the Markdown content, by taking the first 2 levels of titles
examples:
The TOC blocks need some styling yet, and should probably be indented by their sub-level, too. (I'm not sure if that's a template question or CSS question.) I'm in favor of the concept, though.
The TOC blocks need some styling yet, and should probably be indented by their sub-level, too. (I'm not sure if that's a template question or CSS question.) I'm in favor of the concept, though.
yes, as written in the description, the styling is missing (I'll give it a go later but if anyone is interested, I'd be more than happy to get some help here :sweat_smile:) The template already put sub-level into child lists so the indentation should be no problem. I suppose there's a CSS reset somewhere that removed the default margins/padding so it appears flat
Styling should also keep in mind mobile... And that's a bit hard :sweat: any frontender can lend a hand here?
Hi y'all! I gave a try at styling this and made another change: I noticed the TOC would also be generated for other documents related to the PSR/PER listed in the "Additional Info" block, so I put the TOC in there just below its link.
I like it better, but let me know what you think
I also tried to make the Addition Info block sticky. But it's not working well if the block height is greater than the screen so I discarded it for now
(~will update the screenshot in the description soon~ done)
Much improved. It would be useful to "fix" the TOC block when it's in the sidebar, though, so it doesn't scroll off the screen. (Fixing it exactly in place is trivial in CSS. Fixing it to scroll to the top of the page and then be fixed is better, but I'm not sure off hand if that requires any JS these days. I've lost track.)
@Crell It's possible to make it either fixed or sticky when we start scrolling with CSS only (eg: position: sticky;), but if the TOC block height is greater than the viewport height you can't access the bottom part :/