C# API для аналізу файлів Markdown
Використовуйте функції бібліотеки C# для створення елементів, видалення або редагування вмісту існуючих вузлів документа MD.
Аналіз файлів Markdown за допомогою C#
Бібліотека
Aspose.HTML for .NET
надає API аналізу Markdown для платформи C#. Простір імен
Aspose.Html.Toolkit.Markdown.Parser
містить класи та методи для забезпечення повного аналізу і візуалізації Markdown документів.
Ви можете створювати, редагувати, зберігати, об’єднувати, конвертувати файли MD в інші формати файлів, а також додавати посилання, списки, блоки коду, зображення та інші елементи у файли Markdown, перейшовши за посиланнями:
Як розібрати Markdown на C#
Завдання програмного редагування Markdown на C# полягає в зміні елементів у дереві документів MD. API Aspose.HTML for .NET підтримує набір елементів MD, визначених у GitHub Flavored Markdown Spec, а також правила про те, як елементи можуть бути вкладеними. Крім того, простір імен Aspose.Html.Toolkit.Markdown.Extensions містить класи та методи для маніпулювання синтаксисом Markdown на основі специфікацій, які не є частиною специфікації GFM. Розгляньте прості кроки для аналізу та редагування Markdown. Давайте розберемо Markdown і відредагуємо в ньому текстовий вміст:
Аналіз і редагування Markdown на C#
// Specify the path to the source MD file
var input = "C:/temp/input.md";
// Create a MarkdownParser object
var parser = new MarkdownParser();
// Parse the MD document and get a syntax tree
var markdown = parser.ParseFile(input);
// Create a TreeWalker object and navigate through the syntax tree starting at the first node
using var iterator = markdown.CreateTreeWalker(markdown.FirstChild);
while (iterator.NextNode() != null)
{
// Check the type of the current node as EmphasisSyntax
if (iterator.CurrentNode is EmphasisSyntaxNode)
{
var node = (EmphasisSyntaxNode)iterator.CurrentNode;
var n = node.FirstChild;
while (n != null)
{
var next = n.NextSibling;
// Remove the EmphasisSyntax node
node.RemoveChild(n);
n = next;
}
// Get a SyntaxFactory to create new elements
var syntax = markdown.SyntaxFactory;
// Add the text to a new node
node.AppendChild(syntax.Text("new text with"));
// Add whitespase
node.AppendChild(syntax.Whitespace());
// Create an emphasis object
var emphasis = syntax.Emphasis(Emphasis.Strong);
// Add the text into empasis and accumulate a new node
emphasis.AppendChild(syntax.Text("strong emphasis!"));
node.AppendChild(emphasis);
break;
}
}
// Prepare a path for MD file saving
string savePath = Path.Combine(OutputDir, "output-edit.md");
// Save MD file
markdown.Save(savePath);
Кроки для аналізу та редагування Markdown на C#
Розгляньте прості кроки для аналізу Markdown і редагування наявного текстового вмісту:
- Вкажіть шлях до вихідного файлу MD і скористайтеся MarkdownParser() конструктором для ініціалізації нового екземпляра класу MarkdownParser.
- Викличте метод ParseFile(), щоб розібрати Markdown і отримати синтаксичне дерево.
- Створіть об’єкт TreeWalker і перейдіть по синтаксичному дереву Markdown і видаліть непотрібний вміст – вузол EmphasisSyntax.
- Використовуйте властивість SyntaxFactory, щоб отримати фабрику синтаксису для створення нових елементів.
- Створіть новий текстовий вузол і додайте текстовий вміст до нового виділення.
- Використовуйте метод AppendChild(), щоб додати новий вузол до синтаксичного дерева.
- Збережіть відредагований файл MD за допомогою методу Save().
Документація
Щоб дізнатися більше про API Aspose.HTML, відвідайте наш посібник із [документації.(https://docs.aspose.com/html/net/) Ви можете завантажити приклади зі сховища
GitHub.
Вони мають відкритий вихідний код і можуть вільно використовуватися у ваших власних програмах.
Markdown – це проста мова розмітки, яка дозволяє форматувати звичайний текст. Джон Грубер, автор MD, розробив синтаксис форматування Markdown з метою зробити його максимально читабельним. Markdown часто використовується як формат для документації та файлів readme, оскільки він дозволяє писати в стилі, який легко читати та писати. Стаття документації
Markdown Syntax
містить інформацію про основні елементи Markdown, деталі та приклади синтаксису Markdown.
Початок роботи з Aspose.HTML for .NET API
Ви можете скористатися кількома способами інсталяції бібліотеки Aspose.HTML for .NET у вашій системі:
- Установіть пакет NuGet за допомогою графічного інтерфейсу користувача NuGet Package Manager.
- Встановіть пакет NuGet за допомогою консолі диспетчера пакетів. Ви можете використати таку команду
PM> Install-Package Aspose.Html
. - Установіть Aspose.HTML for .NET через MSI.
Ця бібліотека підтримує аналіз HTML5, CSS3, SVG і HTML Canvas для створення об’єктної моделі документа (DOM) на основі стандарту WHATWG DOM. Aspose.HTML for .NET повністю написаний на C# і може використовуватися для створення будь-якого типу 32-розрядних або 64-розрядних додатків .NET, включаючи ASP.NET, WCF, WinForms і .NET Core. Перш ніж запустити приклад коду перетворення .NET, переконайтеся, що у вас ОС, як-от Microsoft Windows, або сумісна з .NET Framework або .NET Standard, і середовище розробки, як-от Microsoft Visual Studio. Додаткову інформацію про встановлення бібліотеки C# та системні вимоги ви знайдете у документації Aspose.HTML.
Системні вимоги
Наші API підтримуються на всіх основних платформах і операційних системах. Перш ніж виконувати код, переконайтеся, що у вашій системі є такі передумови.
- Microsoft Windows або сумісна ОС з платформами .NET Framework, .NET Core, Windows Azure, Mono або Xamarin.
- Середовище розробки, наприклад Microsoft Visual Studio.
- Aspose.HTML for .NET DLL, на який посилається ваш проект – Встановіть із NuGet за допомогою кнопки «Download» вище.