Getting Started

ProMarkdown is a set of Avalonia controls and services for Markdown rendering, editing, selection, hit testing, and extension.

Fast path

  1. Add the ProMarkdown package to an Avalonia application.
  2. Add MarkdownTextBlock to a view.
  3. Bind its Markdown property to application content.
  4. Add only the optional plugin packages your documents need.

Continue with the overview to choose the right integration path, review What's New in 0.1.1 when upgrading, then follow Installation and Render Your First Document. Repository contributors can still use Running the Sample to explore every feature together.