Как создать инлайн код или блок кода Markdown на C#
Библиотека
Aspose.HTML for .NET
– это автономное решение, позволяющее анализировать файлы Markdown и управлять ими без использования другого программного обеспечения. Вы можете создать документ Markdown с нуля, открыть из локального файла и управлять им, вставляя новые элементы, удаляя или редактируя содержимое существующих узлов.
Используйте
Aspose.Html.Toolkit.Markdown.Syntax
и
Aspose.Html.Toolkit.Markdown.Parser
для обеспечения полного синтаксического анализа Markdown и управления синтаксическим деревом MD на основе спецификации GitHub Flavored Markdown (GFM).
Как добавить инлайн код Markdown на C#
Используя библиотеку C#, вы можете программно редактировать файлы MD – изменять структуру и содержимое документа. Создание встроенного кода Markdown или блока кода Markdown на C# имеет особенность, заключающуюся в том, что элемент CodeSpan или FencedCodeBlock необходимо собрать из нескольких узлов, таких как текстовые узлы, пробелы между текстовыми узлами или пустая строка после узла.
Давайте рассмотрим создание документа Markdown с нуля и добавление в него встроенного кода.
Код С# для добавления инлайн кода в файл MD
// 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);
Шаги по созданию кода Markdown на C#
Рассмотрим простые шаги для создания встроенного кода Markdown:
- Создайте новый пустой узел CodeSpan с помощью конструктора CodeSpan() в SyntaxFactory.
- Используйте конструктор Text() для создания текстовых узлов для CodeSpan.
- Вызовите метод AppendChild() класса MarkdownSyntaxNode, чтобы добавить текстовые узлы в элемент CodeSpan.
- Добавить созданный блок кода в синтаксическое дерево документа с помощью метода AppendChild().
- Используйте конструктор Whitespace(), чтобы создать пробел после встроенного кода.
Добавить блок кода Markdown в файл MD на С#
В следующем C# примере показано, как добавить блок кода Markdown в документ MD:
Код C# для добавления блока кода Markdown
// 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);
Документация
Чтобы узнать больше об Aspose.HTML API, посетите нашу
документацию.
. Markdown – это простой язык разметки, который позволяет форматировать обычный текст. Статья документации
Синтаксис Markdown
содержит информацию об основных элементах Markdown, подробности и примеры синтаксиса Markdown.
Начало работы с Aspose.HTML for .NET API
Вы можете использовать несколько способов установки библиотеки Aspose.HTML for .NET в вашей системе:
- Установите пакет NuGet с помощью графического интерфейса диспетчера пакетов NuGet.
- Установите пакет NuGet с помощью консоли диспетчера пакетов.
- Установите Aspose.HTML for .NET через MSI.
Aspose.HTML for .NET поддерживает синтаксический анализ HTML5, CSS3, SVG и HTML Canvas для создания объектной модели документа (DOM) на основе стандарта WHATWG DOM. Библиотека полностью написана на C# и может использоваться для создания любого типа 32-битного или 64-битного приложения .NET, включая ASP.NET, WCF, WinForms и .NET Core. Прежде чем запускать код примера преобразования .NET, убедитесь, что у вас есть ОС, такая как Microsoft Windows, или совместимая с .NET Framework или .NET Standard, и среда разработки, такая как Microsoft Visual Studio. Дополнительные сведения об установке библиотеки C# и системных требованиях вы найдете в документации Aspose.HTML.
Системные Tребования
Наши API поддерживаются на всех основных платформах и операционных системах. Перед выполнением кода убедитесь, что в вашей системе выполнены следующие предварительные условия.
- Microsoft Windows или совместимая ОС с платформами .NET Framework, .NET Core, Windows Azure, Mono или Xamarin.
- Среда разработки, такая как Microsoft Visual Studio.
- Aspose.HTML for .NET DLL, на который есть ссылка в вашем проекте – установите из NuGet с помощью кнопки «Загрузить» выше.