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

Introduction

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

FlexiBlocks is a collection of Markdig extensions for configurable Markdown. It adds structured blocks to ordinary Markdown without replacing the Markdig pipeline you already use.

Overview

Markdig turns Markdown into a document model. FlexiBlocks extends that model with blocks for alerts, banners, cards, code, figures, includes, options, pictures, quotes, sections, tables, tabs and video. Each extension is opt in, so a pipeline can use only the blocks a project needs.

The source stays readable. A writer works in Markdown, not in a proprietary markup language, and the renderer produces the richer markup. Context objects carry shared state between extensions when a block needs information from its surroundings.

Extensions

See the extension index for the full list and a short description of each block. The repository also contains the specifications for every extension.

Requirements

The library is used with Markdig in a .NET application. Install Markdig and FlexiBlocks, then add the extensions to a MarkdownPipelineBuilder. FlexiCodeBlocks and FlexiVideoBlocks need Node.js and FFmpeg respectively for their test suites, not for every document.

Next steps

Follow Getting Started to render a first document, then browse the extensions you plan to use.

Reference shelf