How to Create Markdown Inline Code or Code Block in C#
Aspose.HTML for .NET
library is a stand-alone solution that allows you to parse and manipulate Markdown files without using other software. You can create a Markdown document from scratch, open from a local file and manipulate by inserting new elements, removing, or editing the content of existing nodes.
Use the Aspose.Html.Toolkit.Markdown.Syntax and Aspose.Html.Toolkit.Markdown.Parser namespaces to provide full Markdown parsing and MD syntax tree management based on the GitHub Flavored Markdown (GFM) specification.
How to Add Markdown Inline Code in C#
Using the C# library, you can programmatically edit MD files - change the document structure and content. Creating a Markdown inline code or Markdown code block in C# has a feature, that the CodeSpan or FencedCodeBlock element needs to be assembled from several nodes, such as text nodes, spaces between text nodes, or an empty line after the node.
Let’s look at creating a Markdown document from scratch and adding inline code to it.
C# code to add inline code to MD file
// Create the MarkdownSyntaxTree var markdown = new MarkdownSyntaxTree(new Configuration()); // Use the SyntaxFactory property to get the factory for creating the Markdown syntax tree var mdf = markdown.SyntaxFactory; // Create an empty codeSpan node var codeSpan = mdf.CodeSpan(); // Create text content for the codeSpan codeSpan.AppendChild(mdf.Text("Source code text")); // Add codeSpan to MD document markdown.AppendChild(codeSpan); // Add a space after the code node through a special WhiteSpace node markdown.AppendChild(mdf.Whitespace()); // Prepare a path for MD file saving string savePath = Path.Combine(OutputDir, "markdown-code.md"); // Save MD file markdown.Save(savePath);
Steps to Create Markdown Code in C#
We remind you that the inline code needs to be assembled from the component nodes. Consider simple steps to create Markdown inline code:
- Create a new empty CodeSpan node using CodeSpan() constructor in SyntaxFactory.
- Use the Text() constructor to create text nodes for the CodeSpan.
- Call the AppendChild() method of the MarkdownSyntaxNode class to add text nodes into the CodeSpan element.
- Add created code block to the document syntax tree using AppendChild() method.
- Use the Whitespace() constructor to create space after inline code.
Add Markdown Code Block in C#
The following C# code example shows how to add Markdown code block to MD document:
C# code to add Markdown code block
// Create the MarkdownSyntaxTree var markdown = new MarkdownSyntaxTree(new Configuration()); // Create a Markdown syntax factory var mdf = markdown.SyntaxFactory; // Create a start token and an end token that will frame a code block var startToken = mdf.Token(SourceText.From("```\r\n")); var endToken = mdf.Token(SourceText.From("\r\n```")); // Create a fenced code element var fencedCodeSpan = mdf.FencedCodeBlock(startToken, null, endToken); // Create text content for the fenced code element fencedCodeSpan.AppendChild(mdf.Text("Source code text")); //Add the fenced code element to MD file markdown.AppendChild(fencedCodeSpan); // Prepare a path for MD file saving string savePath = Path.Combine(OutputDir, "markdown-code-block.md"); // Save MD file markdown.Save(savePath);
To learn more about Aspose.HTML API, please visit our
guide. Markdown is a simple markup language that allows you to format plain text. The
documentation article provides information on the main Markdown elements, details and examples of the Markdown syntax.
1. How can I create, parse and edit Markdown in C#?
The Aspose.HTML Library for .NET is a stand-alone solution for working with Markdown documents that does not depend on other software. Install our C# library, add the library reference to your C# project, and programmatically work with Markdown documents.
2. What file formats can be processed with the Aspose.HTML C# library?
We support several file formats that you can create, open, parse, edit, save or convert in C#. These are HTML, XHTML, MHTML and Markdown formats.
3. Can I work with Markdown files on Linux, Mac OS, Android or iOS?
You can work with Markdown documents on any operating system, whether you’re using Windows, Mac OS, Linux, Android, or iOS.
Get Started with .NET HTML API
You can use several ways to install the Aspose.HTML library for .NET on your system:
- Install a NuGet Package using the NuGet Package Manager GUI.
- Install a NuGet Package using the Package Manager Console. You may use the following command
PM> Install-Package Aspose.Html.
- Install Aspose.HTML for .NET through MSI.
This library supports parsing of HTML5, CSS3, SVG and HTML Canvas to construct a Document Object Model (DOM) based on the WHATWG DOM Standard. Aspose.HTML for .NET is written completely in C# and can be used to build any type of 32-bit or 64-bit .NET application including ASP.NET, WCF, WinForms & .NET Core. Before running the .NET conversion example code, make sure that you have OS like Microsoft Windows or a compatible with .NET Framework or .NET Standard, and the development environment like Microsoft Visual Studio. For more details about C# library installation and system requirements, please refer to Aspose.HTML Documentation.
Our APIs are supported on all major platforms and Operating Systems. Before executing the code, please ensure that you have the following prerequisites on your system.
- Microsoft Windows or a compatible OS with .NET Framework, .NET Core, Windows Azure, Mono or Xamarin Platforms.
- Development environment like Microsoft Visual Studio.
- Aspose.Html for .NET DLL referenced in your project - Install from NuGet using the Download button above.