Списки Markdown на C#

Як створити списки Markdown на C#

Бібліотека Aspose.HTML for .NET – це окреме рішення, яке дозволяє аналізувати та маніпулювати файлами Markdown без використання іншого програмного забезпечення. Ви можете створити документ Markdown з нуля, відкрити з локального файлу та маніпулювати, вставляючи нові елементи, видаляючи або редагуючи вміст існуючих вузлів. Markdown підтримує впорядковані (нумеровані) і невпорядковані (марковані) списки. У цій статті ви дізнаєтесь про додавання списків у Markdown за допомогою бібліотеки C#. Використовуйте Aspose.Html.Toolkit.Markdown.Syntax і Aspose.Html.Toolkit.Markdown.Parser простори імен для забезпечення повного синтаксичного аналізу Markdown і керування синтаксичним деревом MD на основі специфікації GitHub Flavored Markdown (GFM).

Створення впорядкованого списку Markdown на C#

Використовуючи бібліотеку C#, ви можете програмно редагувати MD-файли – змінювати структуру та вміст документа. Давайте розглянемо створення нового документа Markdown з нуля та додавання до нього впорядкованого списку.

    // Create the MarkdownSyntaxTree
    var md = new MarkdownSyntaxTree(new Configuration());

    // Create a Markdown syntax factory
    var mdf = md.SyntaxFactory;

    // Create a new empty odered list node
    var orderedList = mdf.OrderedList();

    // Create and add to the odered list a li1 item with the marker “1”
    var li1 = mdf.OrderedListItem(1);
    orderedList.AppendChild(li1);

    // Create a paragraph with text content and add it to the li1 item
    var paragraph = mdf.Paragraph();

    var heading = mdf.AtxHeading("The first element in the Markdown ordered list is the level 3 heading.", 3);
    paragraph.AppendChild(heading);
    li1.AppendChild(paragraph);

    //Create and add to the odered list a li2 item with the marker “2”
    var li2 = mdf.OrderedListItem(2);
    orderedList.AppendChild(li2);

    // Create a strong emphasis with text content and add it to the li2 item
    var bold = mdf.Emphasis(Emphasis.Strong);

    bold.AppendChild(mdf.Text("The second item in the Markdown ordered list is in bold."));
    li2.AppendChild(bold);

    // Add orderedList to MD syntax tree
    md.AppendChild(orderedList);

    // Prepare a path for MD file saving 
    string savePath = Path.Combine(OutputDir, "output-odered-list.md");

    // Save MD file
    md.Save(savePath);

Кроки для створення впорядкованого списку Markdown на C#

Ось кілька простих кроків, щоб створити впорядкований список Markdown:

1. Створіть MarkdownSyntaxTree за допомогою конструктора MarkdownSyntaxTree().
2. Використовуйте властивість SyntaxFactory, щоб отримати фабрику для створення синтаксичного дерева Markdown.
3. Створіть новий вузол orderedList за допомогою конструктора OderedList() у SyntaxFactory.
4. Використовуйте конструктор OrderedListItem(), щоб створити нові екземпляри класу ListItemSyntaxNode з маркером елемента впорядкованого списку.
5. Викличте метод AppendChild() класу MarkdownSyntaxNode, щоб додати елементи впорядкованого списку до вузла orderedList.
6. Після того, як усі елементи з їх вмістом зібрані в єдиний елемент orderedList, додайте його до синтаксичного дерева документа.

Створення невпорядкованого списку Markdown на C#

У наступному прикладі коду C# показано, як додати невпорядкований список до файлу MD:

// Create the MarkdownSyntaxTree
    var md = new MarkdownSyntaxTree(new Configuration());

    // Create a Markdown syntax factoty
    var mdf = md.SyntaxFactory;

    // Create a new empty unodered list node
    var unorderedList = mdf.UnorderedList();

    // Create and add to the unodered list a li1 element with the marker “-”
    var li1 = mdf.UnorderedListItem("-");
    unorderedList.AppendChild(li1);

    // Create a paragraph with text content and add it to the li1 item:
    var paragraph = mdf.Paragraph();
    paragraph.AppendChild(mdf.Text("The first item of the unordered Markdown list."));
    li1.AppendChild(paragraph);

    // Create and add to the unodered list a li2 element with the marker “-”
    var li2 = mdf.UnorderedListItem("-");
    unorderedList.AppendChild(li2);

    // Create a paragraph with text content and add it to the li2 item:
    var paragraph2 = mdf.Paragraph();
    paragraph2.AppendChild(mdf.Text("The second item of the unordered Markdown list."));
    li2.AppendChild(paragraph2);

    // Add unorderedList to MD syntax tree
    md.AppendChild(unorderedList);

    // Prepare a path for MD file saving 
    string savePath = Path.Combine(OutputDir, "markdown-unodered-list.md");

    // Save MD file
    md.Save(savePath);

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

Щоб дізнатися більше про API Aspose.HTML, відвідайте наш посібник із документації . Markdown – це проста мова розмітки, яка дозволяє форматувати звичайний текст. Стаття документації Markdown Syntax містить інформацію про основні елементи Markdown, деталі та приклади синтаксису Markdown.

Початок роботи з Aspose.HTML for .NET API

Ви можете скористатися кількома способами інсталяції бібліотеки Aspose.HTML for .NET у вашій системі:

1. Установіть пакет NuGet за допомогою графічного інтерфейсу користувача NuGet Package Manager.
2. Встановіть пакет NuGet за допомогою консолі диспетчера пакетів. Ви можете використати таку команду PM> Install-Package Aspose.Html.
3. Установіть 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» вище.