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

Advanced

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

These notes are for teams that render Markdown from untrusted sources or ship a documentation pipeline to writers.

Pipeline design

Add only the extensions a project uses. A smaller pipeline is easier to test and gives writers a smaller syntax surface. Keep the pipeline construction in one place so the web site, the build and the tests all render the same way.

Readable source

FlexiBlocks markup sits inside Markdown. Choose a syntax that still reads as text when the renderer is not available. The structurally redundant markup note explains the approach.

Media blocks

FlexiVideoBlocks retrieves video metadata and generates posters with FFmpeg. Keep media processing out of the request path when a document is large. FlexiPictureBlocks can serve responsive images when the front end provides the supporting assets.

Related topics

Reference shelf