Skip to content

Need to find a way to disable indented code-block rendering #502

@sanscontext

Description

@sanscontext

What's wrong? Describe the what you're seeing

Filing this because I can't do this myself.

In many of our docs we use deeply nested lists. In order to preserve the nesting, we have to do a lot of indenting of follow-on steps, images, etc. However, the Kramdown interpreter still detects triple-indented items as the start of a code-block. This is a bad standard; code blocks should only render when specifically invoked by code fences (triple backticks, ```). There's been a lot of disappointingly conservative discussion about this which has always resulted in the maintainers saying that anyone who doesn't like it needs to implement their own workaround. 😤

Suggestions for a fix

I've done a lot of research trying to find a solution to this; a previous Jekyll plugin called Redcarpet allowed you to set a property ( called disable_indented_code_blocks) that would disable this functionality - however it looks like RedCarpet has been EOLed, or is otherwise no longer supported by Jekyll because it's no longer well-maintained by the original project leads. 💀

That's okay. Installing Redcarpet was overkill to get that one feature. My hope is that we can dig through the Redcarpet source and find the relevant parts, then reimplement our own custom parser (using an example like this) to disable indented code blocks.

Mood (optional)

Metadata

Metadata

Assignees

No one assigned

    Labels

    back-endfixes or updates to the site itself, which should not go in release notes

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions