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

Collapsible sections in code fences #2386

Closed
maldoinc opened this issue May 26, 2024 · 1 comment
Closed

Collapsible sections in code fences #2386

maldoinc opened this issue May 26, 2024 · 1 comment
Labels
S: triage Issue needs triage. T: feature Feature.

Comments

@maldoinc
Copy link

Description

Hi all, I've been using this indirectly through mkdocs-material for the docs of my project at https://maldoinc.github.io/wireup/.

Given that it's a library it includes a lot of code fences. Often I find myself debating whether I should include imports in the example or not. I want them there for easy copy-paste of the code and for users to discover where imports are but they also make the code feel a bit more cluttered.

What if there was an option to allow you to collapse a particular part of the code so that it could be used for imports. Perhaps this could be expanded to allow collapsing/expanding any wrapped section in the code fence.

Benefits

This makes the code examples look cleaner by removing imports.

Solution Idea

JOOQ documentation has collapsible import sections https://www.jooq.org/doc/latest/manual/getting-started/the-manual/

@maldoinc maldoinc added the T: feature Feature. label May 26, 2024
@gir-bot gir-bot added the S: triage Issue needs triage. label May 26, 2024
@facelessuser
Copy link
Owner

SuperFences relies on Pygments. Since this functionality does not exist in Pygments, it will not exist in SuperFences. I currently have no plans to try and override Pygments to provide such functionality.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S: triage Issue needs triage. T: feature Feature.
Projects
None yet
Development

No branches or pull requests

3 participants