C# API для аналізу файлів Markdown

Аналіз файлів 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.Наступний код знаходить перше виділення в документі (курсив/жирний) і замінює його вміст на нову фразу з вкладеним жирним текстом, зберігаючи решту структури документа недоторканою:

    // 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 і редагування наявного текстового вмісту:

1. Вкажіть шлях до вихідного файлу MD і скористайтеся MarkdownParser() конструктором для ініціалізації нового екземпляра класу MarkdownParser.
2. Викличте метод ParseFile(), щоб розібрати Markdown і отримати синтаксичне дерево.
3. Створіть об’єкт TreeWalker і перейдіть по синтаксичному дереву Markdown. Видаліть непотрібний вміст – вузол EmphasisSyntax, щоб потім замінити його на інший текстовий вузол.
4. Використовуйте властивість SyntaxFactory , щоб отримати фабрику синтаксису для створення нових елементів.
5. Створіть новий текстовий вузол і додайте текстовий вміст.
6. Використовуйте метод AppendChild() , щоб додати новий вузол до синтаксичного дерева.
7. Збережіть відредагований файл MD за допомогою методу Save() .

Документація

Щоб дізнатися більше про API Aspose.HTML, відвідайте наш посібник із документації . Ви можете завантажити приклади зі сховища GitHub. Вони мають відкритий вихідний код і можуть вільно використовуватися у ваших власних програмах.

Markdown – це проста мова розмітки, яка дозволяє форматувати звичайний текст. Джон Грубер, автор MD, розробив синтаксис форматування Markdown з метою зробити його максимально читабельним. Markdown часто використовується як формат для документації та файлів readme, оскільки він дозволяє писати в стилі, який легко читати та писати. Стаття документації Markdown Syntax містить інформацію про основні елементи Markdown, деталі та приклади синтаксису Markdown.

Установлення Aspose.HTML for .NET

Установіть Aspose.HTML for .NET з NuGet за допомогою .NET CLI:

dotnet add package Aspose.HTML

Також можна скористатися інтерфейсом диспетчера пакетів NuGet або виконати Install-Package Aspose.HTML у консолі диспетчера пакетів. Докладні інструкції наведено в посібнику зі встановлення . Щоб оцінити API без обмежень ознайомлювальної версії, запросіть тимчасову ліцензію .

Системні вимоги

Наші API підтримуються на всіх основних платформах і операційних системах. Перш ніж виконувати код, переконайтеся, що у вашій системі є такі передумови.

• Microsoft Windows або сумісна ОС з платформами .NET Framework, .NET Core, Windows Azure, Mono або Xamarin.
• Середовище розробки, наприклад Microsoft Visual Studio.
• Aspose.HTML for .NET DLL, на який посилається ваш проект – Встановіть із NuGet за допомогою кнопки «Download» вище.