search

WordPress / Learn

WordPress.org Learn - The canonical source for the code and content behind https://learn.WordPress.org
274 stars 100 forks source link

Table of Contents #122

Open courtneyr-dev opened 4 years ago

courtneyr-dev commented 4 years ago

Can lesson plans have the table of contents based upon subheadings, similar to Handbook formatting? Ideally using the new Table of Contents block as a sidebar widget (not directly in post content) image

courtneyr-dev commented 3 years ago

@coreymckrill this one would be helpful soon. I know we have ToCs in Docs that could likely be dropped in to Learn. I also see https://github.com/WordPress/gutenberg/pull/21234 on the roadmap. Could ToC's move into the top right sidebar of Lesson Plans (thus tucking it in as a .... widget as a block....?

coreymckrill commented 3 years ago

I think ideally we'd just use the TOC block that'll be released with Gutenberg 10.1, and we could just add it into the content of any lesson plan or workshop. The Gutenberg plugin is available on all wp.org sites, and I was actually thinking of activating it on Learn anyway, so the TOC block would be available to us long before it makes it into Core.

courtneyr-dev commented 3 years ago

Will we need to add the block per lesson, or can we put it into the sidebar as a widget, or even insert it after the title before post? Asking if we need to manually go add it to each lesson plan.

coreymckrill commented 3 years ago

I'm not sure if the TOC needs to be in the same field as the post content in order to accurately parse all the heading levels. If not, we could probably render it in the sidebar. Needs more investigation.

hlashbrooke commented 3 years ago

This would ideally be displayed in the sidebar. Can we please add this block to the sidebar?

hlashbrooke commented 3 years ago

It looks like development on the TOC block in Gutenberg has stalled - the issue for tracking it is here: https://github.com/WordPress/gutenberg/issues/22874

I'll do some digging and see if this is going to come anytime soon.