Skip to content
Open core software, built in Singapore Established 2018  /  Five utilities
Jering
Talk to us

Structurally Redundant Markup

Markdig.Extensions.FlexiBlocks Jering documentation Open source NuGet package
Documentation menu

Structurally redundant markup is markup that still reads as a document when the rich renderer is not available. It is a useful constraint for teams that edit Markdown in more than one tool.

The idea

FlexiBlocks adds structure to Markdown, but it does not require the structure to replace the prose. A section can begin with a visible heading. An options block can contain a readable list. An include directive can sit beside the content it pulls in.

The result is redundant in a good way: the rendered page uses the richer form, while the source remains understandable to a writer reading plain text or to a tool that does not know the extension.

In practice

  • Start each block with a short label or heading that a reader would recognize.
  • Keep the fallback text meaningful, not a placeholder.
  • Avoid nesting so deeply that the plain text becomes a puzzle.
  • Preview the source in a plain editor before publishing it.

The tradeoff

Redundant markup is slightly longer than the most compact form. That cost buys durability: content survives a change of renderer, a broken build and a reader who only has the raw file. For documentation that lives for years, the trade is usually worth it.

Reference shelf