Folding sections in code blocks

🚀 Feature

Allow irrelevant sections of code to be folded away in code samples.

Have you read the Contributing Guidelines on issues?

Yes

Motivation

Sometimes it’s nice to be able to fold away irrelevant sections in a full code example, so that you can focus on the important parts.

Pitch

For example, if I wrote a Rust function:

fn main() {
    // sample:start
    println!("hello!");
    // sample:end
}

I’d want it to display as (note the indentation):

println!("hello!");

There would be a button on the code block to allow this to be expanded to the full code:

fn main() {
    println!("hello!");
}

Example: Kotlin’s documentation

For a live example, you can check out the Kotlin docs. They seem to have a nice UI for unfolding examples. For example, here is their documentation on defining variables:

• Folded:

  

• Unfolded:

  

• Markdown source:

  

[Josh-Cena]

Time to revive this FR since we need it on our own website: a lot of the examples can be much more concise (e.g. https://docusaurus.io/docs/sidebar#collapsible-categories) if we have the other boilerplate/context collapsed

[Josh-Cena]

This will be closed without getting implemented in core. See https://github.com/facebook/docusaurus/pull/5783#issuecomment-1117161022

In the near future, I will send a PR to dogfood this on our own website, which can be used as an inspiration. I’ll keep this open for now until I make that demo.