From 937383ed1e9ea34b5946365459367b62b0afd94d Mon Sep 17 00:00:00 2001 From: AtchayaSekar28 Date: Thu, 23 Jul 2026 18:40:56 +0530 Subject: [PATCH 1/4] Task (1042583): Revamp Markdown Library in Document SDK UG Documentation --- .../Markdown/Conversions/html-conversions.md | 78 +++++++++---------- .../Markdown/Conversions/markdown-to-pdf.md | 6 +- .../Markdown/Conversions/overview.md | 2 +- .../NET/Assemblies-Required.md | 2 +- .../Document-Object-Model-representation.md | 2 +- .../NET/Loading-and-Saving-document.md | 4 +- .../NET/NuGet-Packages-Required.md | 6 +- .../Markdown/Markdown-Library/NET/Overview.md | 6 +- .../NET/Working-with-Blockquotes.md | 2 +- .../NET/Working-with-Image.md | 16 ++-- .../NET/Working-with-Markdown-document.md | 2 +- .../NET/Working-with-Paragraph.md | 6 +- .../NET/Working-with-code-blocks.md | 12 +-- .../NET/Working-with-lists.md | 14 ++-- .../NET/Working-with-tables.md | 8 +- .../Markdown/Markdown-Library/overview.md | 4 +- Document-Processing/Markdown/overview.md | 10 +-- 17 files changed, 91 insertions(+), 89 deletions(-) diff --git a/Document-Processing/Markdown/Conversions/html-conversions.md b/Document-Processing/Markdown/Conversions/html-conversions.md index 5a194d328a..613dd4244b 100644 --- a/Document-Processing/Markdown/Conversions/html-conversions.md +++ b/Document-Processing/Markdown/Conversions/html-conversions.md @@ -8,11 +8,11 @@ documentation: UG # Markdown to HTML and HTML to Markdown Conversions -Markdown is a lightweight markup language that adds formatting elements to plain text documents. The .NET Word library supports the conversion of Markdown to HTML document and vice versa. +Markdown is a lightweight markup language that adds formatting elements to plain text documents. The Syncfusion® .NET Word (DocIO) library supports converting Markdown to an HTML document and vice versa. ## Assemblies and NuGet packages required -Refer to the following links for assemblies and NuGet packages required based on platforms to convert between Markdown and HTML documents using the .NET Word Library. +Refer to the following links for the assemblies and NuGet packages required, based on the target platform, to convert between Markdown and HTML documents using the .NET Word Library. * [Markdown conversions assemblies](https://help.syncfusion.com/document-processing/word/word-library/net/assemblies-required) * [Markdown conversions NuGet packages](https://help.syncfusion.com/document-processing/word/word-library/net/nuget-packages-required) @@ -32,24 +32,24 @@ N> Refer to the appropriate tabs in the code snippets section: ***C# [Cross-plat using (WordDocument document = new WordDocument(Path.GetFullPath("Input.md"))) { //Save as a HTML document. - document.Save(Path.GetFullPath("Output.html")); + document.Save(Path.GetFullPath("Output.html"), FormatType.Html); } {% endhighlight %} {% highlight c# tabtitle="C# [Windows-specific]" %} //Open an existing Markdown file. -using (WordDocument document = new WordDocument("Input.md")) +using (WordDocument document = new WordDocument("Input.md", FormatType.Markdown)) { - //Save as a HTML document. - document.Save("Output.html"); + //Save as an HTML document. + document.Save("Output.html", FormatType.Html); } {% endhighlight %} {% highlight vb.net tabtitle="VB.NET [Windows-specific]" %} 'Open an existing Markdown file. -Using document As WordDocument = New WordDocument("Input.md") - 'Save as a HTML document. - document.Save("Output.html") +Using document As WordDocument = New WordDocument("Input.md", FormatType.Markdown) + 'Save as an HTML document. + document.Save("Output.html", FormatType.Html) End Using {% endhighlight %} @@ -75,7 +75,7 @@ document.MdImportSettings.ImageNodeVisited += MdImportSettings_ImageNodeVisited; // Open the Markdown file. document.Open(Path.GetFullPath("Input.md")); // Save as a HTML document. -document.Save(Path.GetFullPath("Output.html")); +document.Save(Path.GetFullPath("Output.html"), FormatType.Html); document.Close(); {% endhighlight %} @@ -85,9 +85,9 @@ WordDocument document = new WordDocument(); // Hook the event to customize the image while importing Markdown document. document.MdImportSettings.ImageNodeVisited += MdImportSettings_ImageNodeVisited; // Open the Markdown file. -document.Open("Input.md"); +document.Open("Input.md", FormatType.Markdown); // Save as a HTML document. -document.Save("Output.html"); +document.Save("Output.html", FormatType.Html); document.Close(); {% endhighlight %} @@ -97,9 +97,9 @@ Dim document As WordDocument = New WordDocument() ' Hook the event to customize the image while importing Markdown document. AddHandler document.MdImportSettings.ImageNodeVisited, AddressOf MdImportSettings_ImageNodeVisited ' Open the Markdown file. -document.Open("Input.md") +document.Open("Input.md", FormatType.Markdown) ' Save as a HTML document. -document.Save("Output.html") +document.Save("Output.html", FormatType.Html) document.Close() {% endhighlight %} @@ -172,7 +172,7 @@ End Sub {% endtabs %} -N> Hook the event handler before opening a Markdown document as per the above code example. +N> Hook the event handler before opening a Markdown document as shown in the above code example. ### Encoding @@ -188,9 +188,9 @@ WordDocument document = new WordDocument(); // Set the encoding for the Markdown file. document.MdImportSettings.Encoding = Encoding.UTF8; // Open the Markdown file. -document.Open(Path.GetFullPath("Input.md")); +document.Open(Path.GetFullPath("Input.md"), FormatType.Markdown); // Save as a HTML document. -document.Save(Path.GetFullPath("Output.html")); +document.Save(Path.GetFullPath("Output.html"), FormatType.Html); document.Close(); {% endhighlight %} @@ -200,9 +200,9 @@ WordDocument document = new WordDocument(); // Set the encoding for the Markdown file. document.MdImportSettings.Encoding = Encoding.UTF8; // Open the Markdown file. -document.Open("Input.md"); +document.Open("Input.md", FormatType.Markdown); // Save as a HTML document. -document.Save("Output.html"); +document.Save("Output.html", FormatType.Html); document.Close(); {% endhighlight %} @@ -212,9 +212,9 @@ Dim document As WordDocument = New WordDocument() ' Set the encoding for the Markdown file. document.MdImportSettings.Encoding = Encoding.UTF8 ' Open the Markdown file. -document.Open("Input.md") +document.Open("Input.md", FormatType.Markdown) ' Save as a HTML document. -document.Save("Output.html") +document.Save("Output.html", FormatType.Html) document.Close() {% endhighlight %} @@ -232,27 +232,27 @@ The following code example shows how to convert HTML to Markdown document. {% highlight c# tabtitle="C# [Cross-platform]" %} // Open an existing HTML file. -using (WordDocument document = new WordDocument(Path.GetFullPath("Input.html"))) +using (WordDocument document = new WordDocument(Path.GetFullPath("Input.html"), FormatType.Html)) { //Save as a Markdown document. - document.Save(Path.GetFullPath("Output.md")); + document.Save(Path.GetFullPath("Output.md"), FormatType.Markdown); } {% endhighlight %} {% highlight c# tabtitle="C# [Windows-specific]" %} //Open an existing HTML file. -using (WordDocument document = new WordDocument("Input.html")) +using (WordDocument document = new WordDocument("Input.html", FormatType.Html)) { //Save as a Markdown document. - document.Save("Output.md"); + document.Save("Output.md", FormatType.Markdown); } {% endhighlight %} {% highlight vb.net tabtitle="VB.NET [Windows-specific]" %} 'Open an existing HTML file. -Using document As WordDocument = New WordDocument("Input.html") +Using document As WordDocument = New WordDocument("Input.html", FormatType.Html) 'Save as a Markdown document. - document.Save("Output.md") + document.Save("Output.md", FormatType.Markdown) End Using {% endhighlight %} @@ -272,20 +272,20 @@ The following code example illustrates how to save Image files during an HTML to {% highlight c# tabtitle="C# [Cross-platform]" %} //Open an existing HTML document. - using (WordDocument document = new WordDocument(Path.GetFullPath(@"Data/Input.html"))) + using (WordDocument document = new WordDocument(Path.GetFullPath(@"Data/Input.html"), FormatType.Html)) { //Hook the event to customize the image. document.SaveOptions.MarkdownSaveOptions.ImageNodeVisited += SaveImage; //Save the document as a Markdown file. - document.Save(Path.GetFullPath(@"Output/Output.md")); + document.Save(Path.GetFullPath(@"Output/Output.md"), FormatType.Markdown); } {% endhighlight %} {% highlight c# tabtitle="C# [Windows-specific]" %} -//Open an existing HTML document. -using (WordDocument document = new WordDocument(@"Input.html")) +//Open an existing HTML document. +using (WordDocument document = new WordDocument(@"Input.html", FormatType.Html)) { - //Hook the event to customize the image. + //Hook the event to customize the image. document.SaveOptions.MarkdownSaveOptions.ImageNodeVisited += SaveImage; //Save an HTML document as a Markdown file. document.Save("HtmlToMd.md", FormatType.Markdown); @@ -293,9 +293,9 @@ using (WordDocument document = new WordDocument(@"Input.html")) {% endhighlight %} {% highlight vb.net tabtitle="VB.NET [Windows-specific]" %} -'Open an existing HTML document. -Using document As WordDocument = New WordDocument("Input.html") - 'Hook the event to customize the image. +'Open an existing HTML document. +Using document As WordDocument = New WordDocument("Input.html", FormatType.Html) + 'Hook the event to customize the image. document.SaveOptions.MarkdownSaveOptions.ImageNodeVisited += SaveImage 'Save an HTML document as a Markdown file. document.Save("HtmlToMd.md", FormatType.Markdown) @@ -358,12 +358,12 @@ The following code example shows how to save a Markdown file with a specific enc {% highlight c# tabtitle="C# [Cross-platform]" %} //Open an existing HTML document. -using (WordDocument document = new WordDocument(Path.GetFullPath(@"Data/Input.html"))) +using (WordDocument document = new WordDocument(Path.GetFullPath(@"Data/Input.html"), FormatType.Html)) { //Set the encoding values. document.SaveOptions.MarkdownSaveOptions.Encoding = Encoding.ASCII; //Save the document as a Markdown file. - document.Save(Path.GetFullPath(@"Output/Output.md")); + document.Save(Path.GetFullPath(@"Output/Output.md"), FormatType.Markdown); } {% endhighlight %} @@ -374,7 +374,7 @@ using (WordDocument document = new WordDocument("Input.html")) //Set the encoding values. document.SaveOptions.MarkdownSaveOptions.Encoding = Encoding.ASCII; //Save the document as a Markdown file. - document.Save("HtmlToMd.md"); + document.Save("HtmlToMd.md", FormatType.Markdown); } {% endhighlight %} @@ -384,7 +384,7 @@ Using document As WordDocument = New WordDocument("Input.html") 'Set the encoding values. document.SaveOptions.MarkdownSaveOptions.Encoding = Encoding.ASCII 'Save the document as a Markdown file. - document.Save("HtmlToMd.md") + document.Save("HtmlToMd.md", FormatType.Markdown) End Using {% endhighlight %} diff --git a/Document-Processing/Markdown/Conversions/markdown-to-pdf.md b/Document-Processing/Markdown/Conversions/markdown-to-pdf.md index f91f2327e4..39454df796 100644 --- a/Document-Processing/Markdown/Conversions/markdown-to-pdf.md +++ b/Document-Processing/Markdown/Conversions/markdown-to-pdf.md @@ -8,7 +8,7 @@ documentation: UG # Markdown to PDF Conversion -Markdown is a lightweight markup language that adds formatting elements to plain text documents. The .NET Word library supports the conversion of Markdown to PDF document. +Markdown is a lightweight markup language that adds formatting elements to plain text documents. The .NET Word library supports the conversion of Markdown to a PDF document. ## Assemblies and NuGet packages required @@ -21,7 +21,7 @@ Refer to the following links for assemblies and NuGet packages required based on Convert an existing markdown file to a PDF document using the .NET Word library. -The following code example shows how to convert Markdown to PDF document. +The following code example shows how to convert a Markdown file to a PDF document. N> Refer to the appropriate tabs in the code snippets section: ***C# [Cross-platform]*** for ASP.NET Core, Blazor, Xamarin, UWP, .NET MAUI, and WinUI; ***C# [Windows-specific]*** for WinForms and WPF; ***VB.NET [Windows-specific]*** for VB.NET applications. @@ -88,7 +88,7 @@ When opening an existing Markdown document, the .NET Word library provides custo The .NET Word library provides an `ImageNodeVisited` event, which customizes image data while importing a Markdown file. Implement the logic to customize the image data by using this `ImageNodeVisited` event. -The following code example shows how to load image data based on the image source path when importing the Markdown files. +The following code example shows how to load image data based on the image source path when importing the Markdown file. {% tabs %} diff --git a/Document-Processing/Markdown/Conversions/overview.md b/Document-Processing/Markdown/Conversions/overview.md index 42280574f2..97e8d3ac42 100644 --- a/Document-Processing/Markdown/Conversions/overview.md +++ b/Document-Processing/Markdown/Conversions/overview.md @@ -6,7 +6,7 @@ control: general documentation: UG --- -# Welcome to Syncfusion® Markdown Document Conversion Library +# Welcome to Syncfusion® Markdown Document Conversion Library {% doccards %} diff --git a/Document-Processing/Markdown/Markdown-Library/NET/Assemblies-Required.md b/Document-Processing/Markdown/Markdown-Library/NET/Assemblies-Required.md index 41ecd1db1d..971b64b410 100644 --- a/Document-Processing/Markdown/Markdown-Library/NET/Assemblies-Required.md +++ b/Document-Processing/Markdown/Markdown-Library/NET/Assemblies-Required.md @@ -6,7 +6,7 @@ control: Markdown documentation: UG --- -# Assemblies Required for Markdown +# Assemblies Required for .NET Markdown Library The following assemblies need to be referenced in your application to use the .NET Markdown library. diff --git a/Document-Processing/Markdown/Markdown-Library/NET/Document-Object-Model-representation.md b/Document-Processing/Markdown/Markdown-Library/NET/Document-Object-Model-representation.md index 6a807f6584..190c805311 100644 --- a/Document-Processing/Markdown/Markdown-Library/NET/Document-Object-Model-representation.md +++ b/Document-Processing/Markdown/Markdown-Library/NET/Document-Object-Model-representation.md @@ -6,7 +6,7 @@ control: Markdown documentation: UG --- -# Document Object Model representation in Markdown +# Document Object Model Representation in the Syncfusion® .NET Markdown Library When an existing Markdown document is opened or a new document is created, the Markdown library creates a **Document Object Model** (DOM) of the document in main memory. This object model can be used to manipulate the document as needed. diff --git a/Document-Processing/Markdown/Markdown-Library/NET/Loading-and-Saving-document.md b/Document-Processing/Markdown/Markdown-Library/NET/Loading-and-Saving-document.md index e1162b7b74..6c42746e95 100644 --- a/Document-Processing/Markdown/Markdown-Library/NET/Loading-and-Saving-document.md +++ b/Document-Processing/Markdown/Markdown-Library/NET/Loading-and-Saving-document.md @@ -8,11 +8,11 @@ documentation: UG # Loading and Saving a Markdown Document -The Syncfusion® Markdown library allows you to load an existing Markdown document and save it to the file system or stream programmatically. +The Syncfusion® .NET Markdown library allows you to load an existing Markdown document and save it to the file system or stream programmatically. ## Namespaces required -The following namespaces of Essential® Markdown need to be included in your application to load and save the Markdown document. +The following namespaces need to be included in your application to load and save a Markdown document. N> Refer to the appropriate tabs in the code snippets section: ***C#*** for ASP.NET Core, Blazor, ASP.NET MVC, UWP, .NET MAUI, WinUI, WinForms and WPF; ***VB.NET*** for VB.NET applications. diff --git a/Document-Processing/Markdown/Markdown-Library/NET/NuGet-Packages-Required.md b/Document-Processing/Markdown/Markdown-Library/NET/NuGet-Packages-Required.md index fa83fbe66f..c33c8f4312 100644 --- a/Document-Processing/Markdown/Markdown-Library/NET/NuGet-Packages-Required.md +++ b/Document-Processing/Markdown/Markdown-Library/NET/NuGet-Packages-Required.md @@ -6,11 +6,11 @@ control: Markdown documentation: UG --- -# NuGet Packages Required for Markdown Library +# NuGet Packages Required for .NET Markdown Library ## Installing Syncfusion® Markdown through NuGet Packages -NuGet is the one of the easiest way to download and install Markdown library to create, read, and edit the Markdown documents. The following NuGet packages need to be installed in your application. +NuGet is one of the easiest ways to download and install the Markdown library to create, read, and edit Markdown documents. The following NuGet package needs to be installed in your application. @@ -44,7 +44,7 @@ N> 2. Starting with v34.x.x, if you reference Syncfusion® assemblies from trial ## NuGet Package Installation and Uninstallation -To use Syncfusion® NuGet packages in your project, please refer the NuGet Package [Installation](https://help.syncfusion.com/extension/syncfusion-nuget-packages/nuget-packages) and [Uninstallation](https://help.syncfusion.com/extension/syncfusion-nuget-packages/nuget-uninstallation-process#) sections. +To use Syncfusion® NuGet packages in your project, refer to the NuGet package [Installation](https://help.syncfusion.com/extension/syncfusion-nuget-packages/nuget-packages) and [Uninstallation](https://help.syncfusion.com/extension/syncfusion-nuget-packages/nuget-uninstallation-process#) sections. Markdown NuGet packages can be installed and uninstalled using Package Manager Console. diff --git a/Document-Processing/Markdown/Markdown-Library/NET/Overview.md b/Document-Processing/Markdown/Markdown-Library/NET/Overview.md index a91817e5e0..08f984b8fa 100644 --- a/Document-Processing/Markdown/Markdown-Library/NET/Overview.md +++ b/Document-Processing/Markdown/Markdown-Library/NET/Overview.md @@ -5,11 +5,11 @@ platform: document-processing control: Markdown documentation: UG --- -# Overview of Syncfusion® Markdown library +# Overview of Syncfusion® .NET Markdown library -Essential® Markdown Document Processing library is a native .NET Markdown library that is used by developers to create, read, edit, and manage Markdown documents by using C#, VB.NET, and managed C++ code from any of the following .NET platforms — Windows Forms, WPF, ASP.NET MVC, ASP.NET Core, Blazor, and .NET MAUI applications. +Essential® Markdown Document Processing library is a native .NET library used by developers to create, read, edit, and manage Markdown documents in C# and VB.NET from Windows Forms, WPF, ASP.NET MVC, ASP.NET Core, Blazor, and .NET MAUI applications. -It is a non-UI component that provides a full-fledged document instance model to interact with the Markdown document elements programmatically and perform the necessary manipulation. The library is built from scratch in C# and does not require any Markdown editor or third-party tools to be installed on the machine. +It is a non-UI component that provides a full-fledged document instance model to interact with Markdown document elements programmatically and perform the required operations. The library is built from scratch in C# and does not require any Markdown editor or third-party tools to be installed on the machine. **Key Features** diff --git a/Document-Processing/Markdown/Markdown-Library/NET/Working-with-Blockquotes.md b/Document-Processing/Markdown/Markdown-Library/NET/Working-with-Blockquotes.md index a4b85f30ee..4a63c9deea 100644 --- a/Document-Processing/Markdown/Markdown-Library/NET/Working-with-Blockquotes.md +++ b/Document-Processing/Markdown/Markdown-Library/NET/Working-with-Blockquotes.md @@ -6,7 +6,7 @@ control: Markdown documentation: UG --- -# Working with Blockquotes in Markdown Library +# Working with Blockquotes in the Syncfusion® .NET Markdown Library Blockquotes are used to highlight quoted text, notes, warnings, or other content that needs visual distinction from the main text. In the Syncfusion Markdown library, blockquotes are created using the `HasBlockquote` and `BlockQuoteLevel` properties of the `MdParagraph` class. Blockquotes support single-level and multi-level nesting, and can contain formatted text, links, and other inline elements. diff --git a/Document-Processing/Markdown/Markdown-Library/NET/Working-with-Image.md b/Document-Processing/Markdown/Markdown-Library/NET/Working-with-Image.md index 192ec91296..4c9f51d40e 100644 --- a/Document-Processing/Markdown/Markdown-Library/NET/Working-with-Image.md +++ b/Document-Processing/Markdown/Markdown-Library/NET/Working-with-Image.md @@ -6,13 +6,13 @@ control: Markdown documentation: UG --- -# Working with Images in Markdown Library +# Working with Images in the Syncfusion® .NET Markdown Library -Images are essential elements of Markdown documents that enhance visual communication and documentation. The Syncfusion® Markdown library facilitates adding, modifying, and managing images in a Markdown document. Images in Markdown are represented by the `MdPicture` class, which is an inline element that can be added to a `MdParagraph`. The library supports both URL-based and byte array-based images, allowing you to reference external image files or embed images directly into the document. +Images are essential elements of Markdown documents that enhance visual communication and documentation. The Syncfusion® .NET Markdown library facilitates adding, modifying, and managing images in a Markdown document. Images in Markdown are represented by the `MdPicture` class, which can be added to the inline collection of an `MdParagraph`. The library supports both URL-based and byte array-based images, allowing you to reference external image files or embed images directly into the document. Supported image formats include PNG, JPEG, BMP, GIF, WebP, and SVG. -When saving a Markdown document using the `Save(fileName)` overloads, the library creates a new folder parallel to the output file name and exports all the images into it as default. +When saving a Markdown document using the `Save(fileName)` overloads, the library creates a new folder parallel to the output file name and exports all the images into it by default. -When using the `Save(Stream)` overloads, the library preserves the images as base64 format in the output Markdown file as default. +When using the `Save(Stream)` overloads, the library preserves the images as base64 data URIs in the output Markdown file by default. If the image contains both a URL and stream values, or contains only a URL, the URL will be used in the output document. @@ -68,7 +68,7 @@ markdownDocument.Dispose() A complete working sample is available on [GitHub](https://github.com/SyncfusionExamples/Markdown-Examples/tree/master/Image/Add-image-from-URL/.NET). -## Adding image from file path +## Adding an image from a file path The Syncfusion Markdown library supports adding images from file paths. The following code example demonstrates how to add an image from a file path. @@ -118,9 +118,9 @@ A complete working sample is available on [GitHub](https://github.com/Syncfusion ## Adding image from image bytes -The Syncfusion Markdown library allows embedding images directly into a Markdown document using byte arrays. This is particularly useful when you need to include images that are dynamically generated, retrieved from a database, or loaded from memory. +The Syncfusion® .NET Markdown library allows embedding images directly into a Markdown document using byte arrays. This is useful when you need to include images that are dynamically generated, retrieved from a database, or loaded from memory. When the document is saved with the `Save(fileName)` overload, the bytes are written to the auto-generated images folder; when saved with the `Save(Stream)` overload, the bytes are embedded as a base64 data URI. -The following code example demonstrates how to add an image from a image bytes. +The following code example demonstrates how to add an image from a byte array. {% tabs %} @@ -311,7 +311,7 @@ A complete working sample is available on [GitHub](https://github.com/Syncfusion Alternative text (alt text) is essential for accessibility, providing textual descriptions of images for screen readers and situations where images cannot be displayed. The Syncfusion Markdown library allows you to set and modify alternative text for images using the `AltText` property. -The following code example demonstrates how to add descriptive alternative text to images. +The following code example demonstrates how to add descriptive alternative text to an image. {% tabs %} diff --git a/Document-Processing/Markdown/Markdown-Library/NET/Working-with-Markdown-document.md b/Document-Processing/Markdown/Markdown-Library/NET/Working-with-Markdown-document.md index 0c5d28f96b..b8c32f54c9 100644 --- a/Document-Processing/Markdown/Markdown-Library/NET/Working-with-Markdown-document.md +++ b/Document-Processing/Markdown/Markdown-Library/NET/Working-with-Markdown-document.md @@ -5,7 +5,7 @@ platform: document-processing control: Markdown documentation: UG --- -# Working with Markdown document +# Working with a Markdown Document in the Syncfusion® .NET Markdown Library ## Cloning a Markdown document diff --git a/Document-Processing/Markdown/Markdown-Library/NET/Working-with-Paragraph.md b/Document-Processing/Markdown/Markdown-Library/NET/Working-with-Paragraph.md index e4d583478b..dee6fdabf4 100644 --- a/Document-Processing/Markdown/Markdown-Library/NET/Working-with-Paragraph.md +++ b/Document-Processing/Markdown/Markdown-Library/NET/Working-with-Paragraph.md @@ -6,7 +6,7 @@ control: Markdown documentation: UG --- -# Working with Paragraph in Markdown Library +# Working with Paragraphs in the Syncfusion® .NET Markdown Library A paragraph is the basic building block of a Markdown document. All textual content in a Markdown document is represented by the `MdParagraph` class. Each paragraph contains a collection of inline elements such as text ranges, hyperlinks, and images, which are represented by the `Inlines` property. The `IMdInline` interface is the base interface for all inline elements. The following elements can be the child elements of a paragraph: @@ -178,7 +178,7 @@ A complete working sample is available on [GitHub](https://github.com/Syncfusion ## Applying paragraph styles -Paragraph styles define the visual appearance of a paragraph in a Markdown document. The Syncfusion Markdown library supports heading styles (Heading 1 through Heading 6), blockquote style, and the default normal paragraph style. You can apply a style to a paragraph by using the `ApplyParagraphStyle` method of the `MdParagraph` class. +Paragraph styles define the visual appearance of a paragraph in a Markdown document. The Syncfusion® .NET Markdown library supports heading styles (Heading 1 through Heading 6), the blockquote style, and the default paragraph style (Normal). You can apply a style to a paragraph by using the `ApplyParagraphStyle` method of the `MdParagraph` class. Omitting the call leaves the paragraph in the default Normal style. The following are the supported paragraph styles in the Syncfusion Markdown library: @@ -504,7 +504,7 @@ A complete working sample is available on [GitHub](https://github.com/Syncfusion ## Working with hyperlinks -Hyperlink is a reference to data that can link to external content like images, files, webpage, and more. In a Markdown document, a hyperlink may target to any one of the following sources: +A hyperlink is a reference to data that can link to external content such as images, files, webpages, and more. In a Markdown document, a hyperlink may target any one of the following sources: * Webpage: Represents the web content. * File: Represents the file in some location. diff --git a/Document-Processing/Markdown/Markdown-Library/NET/Working-with-code-blocks.md b/Document-Processing/Markdown/Markdown-Library/NET/Working-with-code-blocks.md index 541cd3319e..de2559f6cd 100644 --- a/Document-Processing/Markdown/Markdown-Library/NET/Working-with-code-blocks.md +++ b/Document-Processing/Markdown/Markdown-Library/NET/Working-with-code-blocks.md @@ -6,20 +6,20 @@ control: Markdown documentation: UG --- -# Working with Code Blocks +# Working with Code Blocks in the Syncfusion® .NET Markdown Library -Code blocks are fundamental elements in technical documentation and Markdown documents used to display programming code, configuration files, command-line instructions, and other preformatted text. The Syncfusion® Markdown library enables you to create, modify, and manage code blocks programmatically in a Markdown document. Code blocks are represented by the `MdCodeBlock` class. +Code blocks are fundamental elements in technical documentation and Markdown documents. They are used to display programming code, configuration files, command-line instructions, and other preformatted text. The Syncfusion® .NET Markdown library enables you to create, modify, and manage code blocks programmatically in a Markdown document. Code blocks are represented by the `MdCodeBlock` class. ## Types of code blocks -The Syncfusion Markdown library supports two primary types of code blocks: +The Syncfusion® .NET Markdown library supports two primary types of code blocks: * **Fenced code blocks**: Code blocks enclosed with triple backticks (```) or triple tildes (~~~), allowing optional language specification for syntax highlighting. * **Indented code blocks**: Traditional code blocks created by indenting each line with four spaces or one tab. N> The `IsFencedCode` property controls the code block type. By default, code blocks are created as fenced code blocks. -## Creating fenced code blocks +## Creating a fenced code block You can add a code block to a `MarkdownDocument` by using the `AddCodeBlock` method. The following code example demonstrates how to create a fenced code block explicitly. @@ -125,9 +125,9 @@ markdownDocument.Dispose() A complete working sample is available on [GitHub](https://github.com/SyncfusionExamples/Markdown-Examples/tree/master/Code-Blocks/Add-indented-code-block/.NET). -## Modifying existing code blocks +## Modifying an existing code block -Existing code blocks in a parsed Markdown document can be modified by iterating through the blocks and updating the `Lines` collection. The following code example demonstrates how to modify code blocks. +Existing code blocks in a parsed Markdown document can be modified by iterating through the blocks and updating the `Lines` collection. The following code example demonstrates how to modify a code block. {% tabs %} diff --git a/Document-Processing/Markdown/Markdown-Library/NET/Working-with-lists.md b/Document-Processing/Markdown/Markdown-Library/NET/Working-with-lists.md index b5beb92526..b6b64a2927 100644 --- a/Document-Processing/Markdown/Markdown-Library/NET/Working-with-lists.md +++ b/Document-Processing/Markdown/Markdown-Library/NET/Working-with-lists.md @@ -6,11 +6,11 @@ control: Markdown documentation: UG --- -# Working with Lists in Markdown Library +# Working with Lists in the Syncfusion® .NET Markdown Library -Lists are essential elements in Markdown documents that organize and present information in a hierarchical and structured manner. The Syncfusion® Markdown library supports creating, modifying, and managing both numbered (ordered) and bulleted (unordered) lists in a Markdown document. Lists are represented by the `MdListFormat` class, which can be applied to a `MdParagraph`. The library supports up to nine nesting levels (level 0 to level 8), allowing for complex hierarchical structures. +Lists are essential elements in Markdown documents that organize and present information in a hierarchical and structured manner. The Syncfusion® .NET Markdown library supports creating, modifying, and managing both numbered (ordered) and bulleted (unordered) lists in a Markdown document. Lists are not separate block types; they are produced by applying an `MdListFormat` instance to an `MdParagraph`. The library supports up to nine nesting levels (level `0` to level `8`), allowing for complex hierarchical structures. -The Syncfusion Markdown library supports two primary types of lists: +The Syncfusion® .NET Markdown library supports two primary types of lists: * **Numbered lists (Ordered lists)**: Lists with sequential numbering such as 1., 2., 3., etc. * **Bulleted lists (Unordered lists)**: Lists with bullet markers such as -, *, or +. @@ -101,7 +101,7 @@ A complete working sample is available on [GitHub](https://github.com/Syncfusion N> The `ListValue` property specifies the complete list prefix including the marker and spacing. For bulleted lists, typical values are "- ", "* ", or "+ ". -## Creating numbered list +## Creating a numbered list A numbered list can be created by setting the `ListFormat` property of a paragraph and `IsNumbered` property to true and configuring the appropriate marker. @@ -197,7 +197,7 @@ A complete working sample is available on [GitHub](https://github.com/Syncfusion N> The `ListValue` property contains the actual number and marker for each item. -## Creating multilevel bulleted list +## Creating a multilevel bulleted list Multilevel bulleted lists can be created by varying the `ListLevel` property. The list level ranges from 0 (root level) to 8 (deepest nested level), supporting up to nine levels of nesting. @@ -333,9 +333,9 @@ A complete working sample is available on [GitHub](https://github.com/Syncfusion N> Each nesting level typically adds spaces of indentation. Level 0 has no indentation. -## Creating multilevel numbered list +## Creating a multilevel numbered list -Multilevel numbered lists can be created by varying the `ListLevel` property. The list level ranges from 0 (root level) to 8 (deepest nested level), supporting up to nine levels of nesting. It combines hierarchical structure with sequential numbering at each level. +Multilevel numbered lists can be created by varying the `ListLevel` property. The list level ranges from `0` (root level) to `8` (deepest nested level), supporting up to nine levels of nesting. A multilevel numbered list combines a hierarchical structure with sequential numbering at each level. The following code example demonstrates how to create a multilevel numbered list. diff --git a/Document-Processing/Markdown/Markdown-Library/NET/Working-with-tables.md b/Document-Processing/Markdown/Markdown-Library/NET/Working-with-tables.md index 8164d1b5dd..d98a97afa9 100644 --- a/Document-Processing/Markdown/Markdown-Library/NET/Working-with-tables.md +++ b/Document-Processing/Markdown/Markdown-Library/NET/Working-with-tables.md @@ -6,9 +6,11 @@ control: Markdown documentation: UG --- -# Working with Tables in Markdown Library +# Working with Tables in the Syncfusion® .NET Markdown Library -Tables are essential components in Markdown documents used to organize and present data in a structured format of rows and columns. The Syncfusion® Markdown library provides comprehensive support for creating, modifying, and managing tables programmatically in a Markdown document. +Tables are essential components in Markdown documents used to organize and present data in a structured format of rows and columns. The Syncfusion® .NET Markdown library provides comprehensive support for creating, modifying, and managing tables programmatically in a Markdown document. + +A table is represented by the following DOM types: * **Table**: Represented by `MdTable`, which is the root container for rows. * **Rows**: Represented by `MdTableRow`, which contains a collection of cells. A table must contain at least one row (typically the header row). @@ -18,7 +20,7 @@ The first row in a Markdown table is typically treated as the header row, follow ## Adding a table -You can add a table to a `MarkdownDocument` by using the `AddTable` method. The alignment for each column can be specified using the `ColumnAlignments` property. The supported alignment options are Left, Center, and Right. +You can add a table to a `MarkdownDocument` by using the `AddTable` method. The alignment for each column can be specified using the `ColumnAlignments` property. The supported alignment options are `Left`, `Center`, and `Right`. The following code example demonstrates how to create a table diff --git a/Document-Processing/Markdown/Markdown-Library/overview.md b/Document-Processing/Markdown/Markdown-Library/overview.md index 51af779470..55c5f1716b 100644 --- a/Document-Processing/Markdown/Markdown-Library/overview.md +++ b/Document-Processing/Markdown/Markdown-Library/overview.md @@ -7,9 +7,9 @@ documentation: UG keywords: markdown, SDK, Automation, API, create, read, edit --- -# Welcome to Syncfusion® Markdown Document Processing Library +# Welcome to Syncfusion® .NET Markdown Document Processing Library -Syncfusion® Markdown Document Processing library is a .NET class library used to create, read, and edit Markdown documents through code in .NET [Windows Forms, WPF, ASP.NET MVC, ASP.NET Core, Blazor, .NET MAUI] applications without any external dependencies. +Syncfusion® .NET Markdown Document Processing library is a .NET class library used to create, read, and edit Markdown documents programmatically in Windows Forms, WPF, ASP.NET MVC, ASP.NET Core, Blazor, and .NET MAUI applications without any external dependencies. It supports various Markdown processing functionalities like creating headings, tables, lists, code blocks, hyperlinks, images, and more. Developers can simply integrate this library to achieve the required Markdown document processing functionalities and focus on the core application logic. diff --git a/Document-Processing/Markdown/overview.md b/Document-Processing/Markdown/overview.md index 53461884a3..70af356eb6 100644 --- a/Document-Processing/Markdown/overview.md +++ b/Document-Processing/Markdown/overview.md @@ -7,12 +7,12 @@ documentation: UG keywords: markdown, SDK, Automation, API, create, read --- -# Welcome to Syncfusion® Markdown Document Processing Framework +# Welcome to Syncfusion® .NET Markdown Document Processing Framework -Syncfusion® Markdown Document Processing Framework is a collection of Markdown document processing library that works without any external dependencies. It eases the developers, as they can just integrate and achieve the required Markdown document processing functionalities and concentrate on core logics of their application. +Syncfusion® .NET Markdown Document Processing Framework is a collection of Markdown document processing library that works without any external dependencies. It eases the developers, as they can just integrate and achieve the required Markdown document processing functionalities and concentrate on core logics of their application. -## List of Markdown Document Processing Products: +## List of Markdown Document Processing Products -* Markdown Library - is a class library used to create, read, and edit Markdown documents through code in .NET [Windows Forms, WPF, ASP.NET MVC, ASP.NET Core, Blazor, .NET MAUI] applications. -* Markdown Conversions - is a class library that convert Markdown documents to Word, HTML, PDF, PowerPoint, Excel. It also supports convert Word, PDF, PowerPoint, Excel, HTML to Markdown documents. +* [Markdown Library](./Markdown-Library/overview) - a class library used to create, read, and edit Markdown documents through code in .NET (Windows Forms, WPF, ASP.NET MVC, ASP.NET Core, Blazor, and .NET MAUI) applications. +* [Markdown Conversions](./Conversions/overview) - a class library that converts Markdown documents to Word, HTML, PDF, PowerPoint, and Excel. It also supports converting Word, PDF, PowerPoint, Excel, and HTML to Markdown documents. From 6def36c30672b653106b78db386fa830248c3003 Mon Sep 17 00:00:00 2001 From: AtchayaSekar28 Date: Thu, 23 Jul 2026 19:01:14 +0530 Subject: [PATCH 2/4] removed the format type in html conversions --- .../Markdown/Conversions/html-conversions.md | 60 +++++++++---------- 1 file changed, 30 insertions(+), 30 deletions(-) diff --git a/Document-Processing/Markdown/Conversions/html-conversions.md b/Document-Processing/Markdown/Conversions/html-conversions.md index 613dd4244b..2293783cc7 100644 --- a/Document-Processing/Markdown/Conversions/html-conversions.md +++ b/Document-Processing/Markdown/Conversions/html-conversions.md @@ -32,24 +32,24 @@ N> Refer to the appropriate tabs in the code snippets section: ***C# [Cross-plat using (WordDocument document = new WordDocument(Path.GetFullPath("Input.md"))) { //Save as a HTML document. - document.Save(Path.GetFullPath("Output.html"), FormatType.Html); + document.Save(Path.GetFullPath("Output.html")); } {% endhighlight %} {% highlight c# tabtitle="C# [Windows-specific]" %} //Open an existing Markdown file. -using (WordDocument document = new WordDocument("Input.md", FormatType.Markdown)) +using (WordDocument document = new WordDocument("Input.md")) { //Save as an HTML document. - document.Save("Output.html", FormatType.Html); + document.Save("Output.html"); } {% endhighlight %} {% highlight vb.net tabtitle="VB.NET [Windows-specific]" %} 'Open an existing Markdown file. -Using document As WordDocument = New WordDocument("Input.md", FormatType.Markdown) +Using document As WordDocument = New WordDocument("Input.md") 'Save as an HTML document. - document.Save("Output.html", FormatType.Html) + document.Save("Output.html") End Using {% endhighlight %} @@ -75,7 +75,7 @@ document.MdImportSettings.ImageNodeVisited += MdImportSettings_ImageNodeVisited; // Open the Markdown file. document.Open(Path.GetFullPath("Input.md")); // Save as a HTML document. -document.Save(Path.GetFullPath("Output.html"), FormatType.Html); +document.Save(Path.GetFullPath("Output.html")); document.Close(); {% endhighlight %} @@ -85,9 +85,9 @@ WordDocument document = new WordDocument(); // Hook the event to customize the image while importing Markdown document. document.MdImportSettings.ImageNodeVisited += MdImportSettings_ImageNodeVisited; // Open the Markdown file. -document.Open("Input.md", FormatType.Markdown); +document.Open("Input.md"); // Save as a HTML document. -document.Save("Output.html", FormatType.Html); +document.Save("Output.html"); document.Close(); {% endhighlight %} @@ -97,9 +97,9 @@ Dim document As WordDocument = New WordDocument() ' Hook the event to customize the image while importing Markdown document. AddHandler document.MdImportSettings.ImageNodeVisited, AddressOf MdImportSettings_ImageNodeVisited ' Open the Markdown file. -document.Open("Input.md", FormatType.Markdown) +document.Open("Input.md") ' Save as a HTML document. -document.Save("Output.html", FormatType.Html) +document.Save("Output.html") document.Close() {% endhighlight %} @@ -188,9 +188,9 @@ WordDocument document = new WordDocument(); // Set the encoding for the Markdown file. document.MdImportSettings.Encoding = Encoding.UTF8; // Open the Markdown file. -document.Open(Path.GetFullPath("Input.md"), FormatType.Markdown); +document.Open(Path.GetFullPath("Input.md")); // Save as a HTML document. -document.Save(Path.GetFullPath("Output.html"), FormatType.Html); +document.Save(Path.GetFullPath("Output.html")); document.Close(); {% endhighlight %} @@ -200,9 +200,9 @@ WordDocument document = new WordDocument(); // Set the encoding for the Markdown file. document.MdImportSettings.Encoding = Encoding.UTF8; // Open the Markdown file. -document.Open("Input.md", FormatType.Markdown); +document.Open("Input.md"); // Save as a HTML document. -document.Save("Output.html", FormatType.Html); +document.Save("Output.html"); document.Close(); {% endhighlight %} @@ -212,9 +212,9 @@ Dim document As WordDocument = New WordDocument() ' Set the encoding for the Markdown file. document.MdImportSettings.Encoding = Encoding.UTF8 ' Open the Markdown file. -document.Open("Input.md", FormatType.Markdown) +document.Open("Input.md") ' Save as a HTML document. -document.Save("Output.html", FormatType.Html) +document.Save("Output.html") document.Close() {% endhighlight %} @@ -232,27 +232,27 @@ The following code example shows how to convert HTML to Markdown document. {% highlight c# tabtitle="C# [Cross-platform]" %} // Open an existing HTML file. -using (WordDocument document = new WordDocument(Path.GetFullPath("Input.html"), FormatType.Html)) +using (WordDocument document = new WordDocument(Path.GetFullPath("Input.html"))) { //Save as a Markdown document. - document.Save(Path.GetFullPath("Output.md"), FormatType.Markdown); + document.Save(Path.GetFullPath("Output.md")); } {% endhighlight %} {% highlight c# tabtitle="C# [Windows-specific]" %} //Open an existing HTML file. -using (WordDocument document = new WordDocument("Input.html", FormatType.Html)) +using (WordDocument document = new WordDocument("Input.html")) { //Save as a Markdown document. - document.Save("Output.md", FormatType.Markdown); + document.Save("Output.md"); } {% endhighlight %} {% highlight vb.net tabtitle="VB.NET [Windows-specific]" %} 'Open an existing HTML file. -Using document As WordDocument = New WordDocument("Input.html", FormatType.Html) +Using document As WordDocument = New WordDocument("Input.html") 'Save as a Markdown document. - document.Save("Output.md", FormatType.Markdown) + document.Save("Output.md") End Using {% endhighlight %} @@ -272,18 +272,18 @@ The following code example illustrates how to save Image files during an HTML to {% highlight c# tabtitle="C# [Cross-platform]" %} //Open an existing HTML document. - using (WordDocument document = new WordDocument(Path.GetFullPath(@"Data/Input.html"), FormatType.Html)) + using (WordDocument document = new WordDocument(Path.GetFullPath(@"Data/Input.html"))) { //Hook the event to customize the image. document.SaveOptions.MarkdownSaveOptions.ImageNodeVisited += SaveImage; //Save the document as a Markdown file. - document.Save(Path.GetFullPath(@"Output/Output.md"), FormatType.Markdown); + document.Save(Path.GetFullPath(@"Output/Output.md")); } {% endhighlight %} {% highlight c# tabtitle="C# [Windows-specific]" %} //Open an existing HTML document. -using (WordDocument document = new WordDocument(@"Input.html", FormatType.Html)) +using (WordDocument document = new WordDocument(@"Input.html")) { //Hook the event to customize the image. document.SaveOptions.MarkdownSaveOptions.ImageNodeVisited += SaveImage; @@ -294,7 +294,7 @@ using (WordDocument document = new WordDocument(@"Input.html", FormatType.Html)) {% highlight vb.net tabtitle="VB.NET [Windows-specific]" %} 'Open an existing HTML document. -Using document As WordDocument = New WordDocument("Input.html", FormatType.Html) +Using document As WordDocument = New WordDocument("Input.html") 'Hook the event to customize the image. document.SaveOptions.MarkdownSaveOptions.ImageNodeVisited += SaveImage 'Save an HTML document as a Markdown file. @@ -358,12 +358,12 @@ The following code example shows how to save a Markdown file with a specific enc {% highlight c# tabtitle="C# [Cross-platform]" %} //Open an existing HTML document. -using (WordDocument document = new WordDocument(Path.GetFullPath(@"Data/Input.html"), FormatType.Html)) +using (WordDocument document = new WordDocument(Path.GetFullPath(@"Data/Input.html"))) { //Set the encoding values. document.SaveOptions.MarkdownSaveOptions.Encoding = Encoding.ASCII; //Save the document as a Markdown file. - document.Save(Path.GetFullPath(@"Output/Output.md"), FormatType.Markdown); + document.Save(Path.GetFullPath(@"Output/Output.md")); } {% endhighlight %} @@ -374,7 +374,7 @@ using (WordDocument document = new WordDocument("Input.html")) //Set the encoding values. document.SaveOptions.MarkdownSaveOptions.Encoding = Encoding.ASCII; //Save the document as a Markdown file. - document.Save("HtmlToMd.md", FormatType.Markdown); + document.Save("HtmlToMd.md"); } {% endhighlight %} @@ -384,7 +384,7 @@ Using document As WordDocument = New WordDocument("Input.html") 'Set the encoding values. document.SaveOptions.MarkdownSaveOptions.Encoding = Encoding.ASCII 'Save the document as a Markdown file. - document.Save("HtmlToMd.md", FormatType.Markdown) + document.Save("HtmlToMd.md") End Using {% endhighlight %} From 9ae1aaef5ef76b77bc52a20883a5f5c61d75eb7b Mon Sep 17 00:00:00 2001 From: AtchayaSekar28 Date: Thu, 23 Jul 2026 19:27:24 +0530 Subject: [PATCH 3/4] Resolved the CI Failures --- Document-Processing/Markdown/Conversions/overview.md | 2 +- .../NET/Document-Object-Model-representation.md | 2 +- .../Markdown/Markdown-Library/NET/Working-with-Blockquotes.md | 2 +- .../Markdown/Markdown-Library/NET/Working-with-Image.md | 2 +- .../Markdown-Library/NET/Working-with-Markdown-document.md | 2 +- .../Markdown/Markdown-Library/NET/Working-with-Paragraph.md | 2 +- .../Markdown/Markdown-Library/NET/Working-with-code-blocks.md | 2 +- .../Markdown/Markdown-Library/NET/Working-with-lists.md | 2 +- .../Markdown/Markdown-Library/NET/Working-with-tables.md | 2 +- Document-Processing/Markdown/Markdown-Library/overview.md | 2 +- Document-Processing/Markdown/overview.md | 2 +- 11 files changed, 11 insertions(+), 11 deletions(-) diff --git a/Document-Processing/Markdown/Conversions/overview.md b/Document-Processing/Markdown/Conversions/overview.md index 97e8d3ac42..42280574f2 100644 --- a/Document-Processing/Markdown/Conversions/overview.md +++ b/Document-Processing/Markdown/Conversions/overview.md @@ -6,7 +6,7 @@ control: general documentation: UG --- -# Welcome to Syncfusion® Markdown Document Conversion Library +# Welcome to Syncfusion® Markdown Document Conversion Library {% doccards %} diff --git a/Document-Processing/Markdown/Markdown-Library/NET/Document-Object-Model-representation.md b/Document-Processing/Markdown/Markdown-Library/NET/Document-Object-Model-representation.md index 190c805311..6a807f6584 100644 --- a/Document-Processing/Markdown/Markdown-Library/NET/Document-Object-Model-representation.md +++ b/Document-Processing/Markdown/Markdown-Library/NET/Document-Object-Model-representation.md @@ -6,7 +6,7 @@ control: Markdown documentation: UG --- -# Document Object Model Representation in the Syncfusion® .NET Markdown Library +# Document Object Model representation in Markdown When an existing Markdown document is opened or a new document is created, the Markdown library creates a **Document Object Model** (DOM) of the document in main memory. This object model can be used to manipulate the document as needed. diff --git a/Document-Processing/Markdown/Markdown-Library/NET/Working-with-Blockquotes.md b/Document-Processing/Markdown/Markdown-Library/NET/Working-with-Blockquotes.md index 4a63c9deea..a4b85f30ee 100644 --- a/Document-Processing/Markdown/Markdown-Library/NET/Working-with-Blockquotes.md +++ b/Document-Processing/Markdown/Markdown-Library/NET/Working-with-Blockquotes.md @@ -6,7 +6,7 @@ control: Markdown documentation: UG --- -# Working with Blockquotes in the Syncfusion® .NET Markdown Library +# Working with Blockquotes in Markdown Library Blockquotes are used to highlight quoted text, notes, warnings, or other content that needs visual distinction from the main text. In the Syncfusion Markdown library, blockquotes are created using the `HasBlockquote` and `BlockQuoteLevel` properties of the `MdParagraph` class. Blockquotes support single-level and multi-level nesting, and can contain formatted text, links, and other inline elements. diff --git a/Document-Processing/Markdown/Markdown-Library/NET/Working-with-Image.md b/Document-Processing/Markdown/Markdown-Library/NET/Working-with-Image.md index 4c9f51d40e..deef57e3ae 100644 --- a/Document-Processing/Markdown/Markdown-Library/NET/Working-with-Image.md +++ b/Document-Processing/Markdown/Markdown-Library/NET/Working-with-Image.md @@ -6,7 +6,7 @@ control: Markdown documentation: UG --- -# Working with Images in the Syncfusion® .NET Markdown Library +# Working with Images in Markdown Library Images are essential elements of Markdown documents that enhance visual communication and documentation. The Syncfusion® .NET Markdown library facilitates adding, modifying, and managing images in a Markdown document. Images in Markdown are represented by the `MdPicture` class, which can be added to the inline collection of an `MdParagraph`. The library supports both URL-based and byte array-based images, allowing you to reference external image files or embed images directly into the document. Supported image formats include PNG, JPEG, BMP, GIF, WebP, and SVG. diff --git a/Document-Processing/Markdown/Markdown-Library/NET/Working-with-Markdown-document.md b/Document-Processing/Markdown/Markdown-Library/NET/Working-with-Markdown-document.md index b8c32f54c9..0c5d28f96b 100644 --- a/Document-Processing/Markdown/Markdown-Library/NET/Working-with-Markdown-document.md +++ b/Document-Processing/Markdown/Markdown-Library/NET/Working-with-Markdown-document.md @@ -5,7 +5,7 @@ platform: document-processing control: Markdown documentation: UG --- -# Working with a Markdown Document in the Syncfusion® .NET Markdown Library +# Working with Markdown document ## Cloning a Markdown document diff --git a/Document-Processing/Markdown/Markdown-Library/NET/Working-with-Paragraph.md b/Document-Processing/Markdown/Markdown-Library/NET/Working-with-Paragraph.md index dee6fdabf4..4c16ddcafa 100644 --- a/Document-Processing/Markdown/Markdown-Library/NET/Working-with-Paragraph.md +++ b/Document-Processing/Markdown/Markdown-Library/NET/Working-with-Paragraph.md @@ -6,7 +6,7 @@ control: Markdown documentation: UG --- -# Working with Paragraphs in the Syncfusion® .NET Markdown Library +# Working with Paragraph in Markdown Library A paragraph is the basic building block of a Markdown document. All textual content in a Markdown document is represented by the `MdParagraph` class. Each paragraph contains a collection of inline elements such as text ranges, hyperlinks, and images, which are represented by the `Inlines` property. The `IMdInline` interface is the base interface for all inline elements. The following elements can be the child elements of a paragraph: diff --git a/Document-Processing/Markdown/Markdown-Library/NET/Working-with-code-blocks.md b/Document-Processing/Markdown/Markdown-Library/NET/Working-with-code-blocks.md index de2559f6cd..385b2ab7ac 100644 --- a/Document-Processing/Markdown/Markdown-Library/NET/Working-with-code-blocks.md +++ b/Document-Processing/Markdown/Markdown-Library/NET/Working-with-code-blocks.md @@ -6,7 +6,7 @@ control: Markdown documentation: UG --- -# Working with Code Blocks in the Syncfusion® .NET Markdown Library +# Working with Code Blocks Code blocks are fundamental elements in technical documentation and Markdown documents. They are used to display programming code, configuration files, command-line instructions, and other preformatted text. The Syncfusion® .NET Markdown library enables you to create, modify, and manage code blocks programmatically in a Markdown document. Code blocks are represented by the `MdCodeBlock` class. diff --git a/Document-Processing/Markdown/Markdown-Library/NET/Working-with-lists.md b/Document-Processing/Markdown/Markdown-Library/NET/Working-with-lists.md index b6b64a2927..f694728ec9 100644 --- a/Document-Processing/Markdown/Markdown-Library/NET/Working-with-lists.md +++ b/Document-Processing/Markdown/Markdown-Library/NET/Working-with-lists.md @@ -6,7 +6,7 @@ control: Markdown documentation: UG --- -# Working with Lists in the Syncfusion® .NET Markdown Library +# Working with Lists in Markdown Library Lists are essential elements in Markdown documents that organize and present information in a hierarchical and structured manner. The Syncfusion® .NET Markdown library supports creating, modifying, and managing both numbered (ordered) and bulleted (unordered) lists in a Markdown document. Lists are not separate block types; they are produced by applying an `MdListFormat` instance to an `MdParagraph`. The library supports up to nine nesting levels (level `0` to level `8`), allowing for complex hierarchical structures. diff --git a/Document-Processing/Markdown/Markdown-Library/NET/Working-with-tables.md b/Document-Processing/Markdown/Markdown-Library/NET/Working-with-tables.md index d98a97afa9..a60169cefd 100644 --- a/Document-Processing/Markdown/Markdown-Library/NET/Working-with-tables.md +++ b/Document-Processing/Markdown/Markdown-Library/NET/Working-with-tables.md @@ -6,7 +6,7 @@ control: Markdown documentation: UG --- -# Working with Tables in the Syncfusion® .NET Markdown Library +# Working with Tables in Markdown Library Tables are essential components in Markdown documents used to organize and present data in a structured format of rows and columns. The Syncfusion® .NET Markdown library provides comprehensive support for creating, modifying, and managing tables programmatically in a Markdown document. diff --git a/Document-Processing/Markdown/Markdown-Library/overview.md b/Document-Processing/Markdown/Markdown-Library/overview.md index 55c5f1716b..0b8208a600 100644 --- a/Document-Processing/Markdown/Markdown-Library/overview.md +++ b/Document-Processing/Markdown/Markdown-Library/overview.md @@ -7,7 +7,7 @@ documentation: UG keywords: markdown, SDK, Automation, API, create, read, edit --- -# Welcome to Syncfusion® .NET Markdown Document Processing Library +# Welcome to Syncfusion® Markdown Document Processing Library Syncfusion® .NET Markdown Document Processing library is a .NET class library used to create, read, and edit Markdown documents programmatically in Windows Forms, WPF, ASP.NET MVC, ASP.NET Core, Blazor, and .NET MAUI applications without any external dependencies. diff --git a/Document-Processing/Markdown/overview.md b/Document-Processing/Markdown/overview.md index 70af356eb6..98ff839395 100644 --- a/Document-Processing/Markdown/overview.md +++ b/Document-Processing/Markdown/overview.md @@ -7,7 +7,7 @@ documentation: UG keywords: markdown, SDK, Automation, API, create, read --- -# Welcome to Syncfusion® .NET Markdown Document Processing Framework +# Welcome to Syncfusion® Markdown Document Processing Framework Syncfusion® .NET Markdown Document Processing Framework is a collection of Markdown document processing library that works without any external dependencies. It eases the developers, as they can just integrate and achieve the required Markdown document processing functionalities and concentrate on core logics of their application. From c342d700e3fb377b40e7bb662f5c671159e44068 Mon Sep 17 00:00:00 2001 From: AtchayaSekar28 Date: Thu, 23 Jul 2026 19:31:27 +0530 Subject: [PATCH 4/4] Resolved CI issue --- Document-Processing/Markdown/Markdown-Library/NET/Overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Document-Processing/Markdown/Markdown-Library/NET/Overview.md b/Document-Processing/Markdown/Markdown-Library/NET/Overview.md index 08f984b8fa..f482dadf11 100644 --- a/Document-Processing/Markdown/Markdown-Library/NET/Overview.md +++ b/Document-Processing/Markdown/Markdown-Library/NET/Overview.md @@ -5,7 +5,7 @@ platform: document-processing control: Markdown documentation: UG --- -# Overview of Syncfusion® .NET Markdown library +# Overview of Syncfusion® Markdown library Essential® Markdown Document Processing library is a native .NET library used by developers to create, read, edit, and manage Markdown documents in C# and VB.NET from Windows Forms, WPF, ASP.NET MVC, ASP.NET Core, Blazor, and .NET MAUI applications.