Oakrey.Markdown 1.0.1

Oakrey.Markdown

Overview

The "Markdown" project provides a framework for parsing, processing, and rendering Markdown content in .NET applications. It supports advanced Markdown features, including tables, code blocks, images, and text decorations, and integrates seamlessly with WPF for rendering styled Markdown content.

Feature

Markdown Parsing:

• MarkdownProcessor: Core class for transforming Markdown text into WPF FlowDocument objects.
• Supports block-level and inline-level parsing using a modular parser architecture.

Advanced Markdown Features:

• Tables (MdTables, MdTableCell, MdTable).
• Code blocks with or without language specification (MdCodeBlocks).
• Headers, blockquotes, lists, and rules (MdHeader, MdBlockquotes, MdList, MdRule).
• Inline elements like images and text decorations (MdImage, MdTextDecoration).

Customizable Styles:

• MarkdownProcessor.Style.xaml: Provides WPF styles for rendering Markdown content.
• DocumentStyle property allows customization of the rendered FlowDocument.

Emoji and Text Utilities:

• EmojiTable: Supports rendering emojis in Markdown.
• TextUtilities: Normalizes and processes text for consistent rendering.

Extensibility:

• Modular parser design with interfaces like IBlockParser and IInlineParser.
• Custom parsers can be added for additional Markdown features.

WPF Integration:

• MarkdownScrollViewer: A WPF control for displaying Markdown content.
• Leverages WPF's FlowDocument for rich text rendering.

Assets and Resources:

Includes syntax highlighting definitions (XmlDefinition.xshd) and emoji support (EmojiTable.txt).

Installation

You can install the package via NuGet Package Manager, Package Manager Console or the .NET CLI.

NuGet Package Manager

1. Open your project in Visual Studio.
2. Navigate to Tools > NuGet Package Manager > Manage NuGet Packages for Solution....
3. Search for Oakrey.Markdown and click Install.

.NET CLI

Run the following command in your terminal:

dotnet add package Oakrey.Markdown

Package Manager Console

Run the following command in your Package Manager Console:

Install-Package Oakrey.Markdown

Requirements

• .NET 8 or higher

Project Information

• Author: Oakrey
• Company: Oakrey
• License: MIT
• Repository: Git Repository
• Project URL: Project Website

Contributing

Contributions are welcome! Feel free to open issues or submit pull requests to improve the package.

License

This project is licensed under the MIT License. See the LICENSE file for details.