Как создать Markdown Paragraph на C#

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


Как добавить Markdown Paragraph на C#

Используя библиотеку C#, вы можете программно редактировать файлы MD – изменять структуру и содержимое документа. Создание элемента Paragraph на C# имеет особенность. Особенность в том, что Paragraph нужно собрать из нескольких узлов, таких как текстовые узлы, пробелы между текстовыми узлами и пустая строка после параграфа. Давайте рассмотрим создание нового документа Markdown с нуля и добавление в него двух параграфов.

Код C# для редактирования файлов MD

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

    // Use the SyntaxFactory property to get the factory for creating the Markdown syntax tree
    var mdf = md.SyntaxFactory;

    // Create an empty paragraph1
    var paragraph1 = mdf.Paragraph();

    // Add texts to the paragraph1
    paragraph1.AppendChild(mdf.Text("The first sentence of the first paragraph."));
    // Add a space after the first sentence in the paragraph through a special WhiteSpace node
    paragraph1.AppendChild(mdf.Whitespace());

    paragraph1.AppendChild(mdf.Text("The second sentence of the first paragraph."));

    // Create and add newLineTrivia element for an empty line after paragraph1 
    var newLineTrivia = mdf.NewLineTrivia();
    paragraph1.GetTrailingTrivia().Add(newLineTrivia);

    // Add the filled paragraph1 into MD document
    md.AppendChild(paragraph1);

    // Create an empty paragraph2
    var paragraph2 = mdf.Paragraph();

    // Add texts to the paragraph2
    paragraph2.AppendChild(mdf.Text("The first sentence of the second paragraph."));
    // Add a space after the first sentence in the paragraph through a special WhiteSpace node
    paragraph2.AppendChild(mdf.Whitespace());

    paragraph2.AppendChild(mdf.Text("The second sentence of the second paragraph."));

    // Add newLineTrivia element for an empty line after paragraph2
    paragraph2.GetTrailingTrivia().Add(newLineTrivia);

    // Add the filled paragraph2 into MD document as a last child
    md.AppendChild(paragraph2);

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

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



Шаги по созданию Markdown Paragraph на С#

Напоминаем, что Paragraph нужно собрать из узлов-компонентов. Рассмотрим простые шаги для создания параграфа в Markdown:

  1. Создайте новый пустой узел, используя конструктор Paragraph() в SyntaxFactory.
  2. Используйте конструктор Text() для создания текстовых узлов для абзаца.
  3. Вызовите метод AppendChild() класса MarkdownSyntaxNode, чтобы добавить текстовые узлы и пробелы. в абзац.
  4. Используйте конструктор Whitespace(), чтобы создать пространство между текстовыми узлами в параграфе
  5. Создайте и добавьте элемент newLineTrivia для пустой строки после абзаца. Используйте конструктор NewLineTrivia() и метод Add().
  6. После того, как все узлы абзаца собраны в один элемент, добавьте его в синтаксическое дерево документа.

Добавить Markdown Paragraph в существующий файл MD на С#

В следующем примере кода C# показано, как добавить параграф в существующий документ MD:

Код 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 syntaxTree = parser.ParseFile(input);

    // Get a SyntaxFactory to create new elements 
    var syntaxFactory = syntaxTree.SyntaxFactory;

    // Create a new empty paragraph 
    var paragraphSyntaxNode = syntaxFactory.Paragraph();

    // Create and add newLineTrivia element for an empty line after paragraph 
    var newLineTrivia = syntaxFactory.NewLineTrivia();
    paragraphSyntaxNode.GetTrailingTrivia().Add(newLineTrivia);
            
    // Create text content for the paragraph 
    var textSyntaxNode = syntaxFactory.Text("Markdown language is simple to learn. It has minimal extra characters, so you can quickly write and make fewer errors.");

    // Add text into paragraph
    paragraphSyntaxNode.AppendChild(textSyntaxNode);

    // Add paragraph to MD document before the first element of the syntax tree
    syntaxTree.InsertBefore(paragraphSyntaxNode, syntaxTree.FirstChild);

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

    // Save Markdown file
    syntaxTree.Save(savePath);

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

Чтобы узнать больше об Aspose.HTML API, посетите нашу документацию. Markdown – это простой язык разметки, который позволяет форматировать обычный текст. Статья документации Синтаксис Markdown содержит информацию об основных элементах Markdown, подробности и примеры синтаксиса Markdown.


FAQ

1. Как создавать, анализировать и редактировать Markdown на C#?

Библиотека Aspose.HTML for .NET – это автономное решение для работы с файлами Markdown, которое не зависит от другого программного обеспечения. Установите нашу библиотеку C#, добавьте ссылку на библиотеку в свой проект C# и программно работайте с документами Markdown и управляйте ими.

2. Почему Markdown так популярен?

Markdown очень популярен среди писателей, разработчиков и создателей контента благодаря своей универсальности. Его преимущества включают простой для изучения и использования синтаксис, переносимость, гибкость и удобство использования. Markdown прост и интуитивно понятен и может быть конвертирован в HTML, PDF или другие форматы.

3. Могу ли я работать с файлами Markdown в Linux, Mac OS, Android или iOS?

Вы можете работать с документами Markdown в любой операционной системе, независимо от того, используете ли вы Windows, Mac OS, Linux, Android или iOS

4. Файлы каких форматов можно обрабатывать с помощью библиотеки Aspose.HTML C#?

Мы поддерживаем несколько форматов файлов, которые вы можете создавать, открывать, анализировать, редактировать, сохранять или конвертировать на C#. Это форматы HTML, XHTML, MHTML и Markdown



Начало работы с .NET HTML API

Вы можете использовать несколько способов установки библиотеки Aspose.HTML для .NET в вашей системе:

  • Установите пакет NuGet с помощью графического интерфейса диспетчера пакетов NuGet.
  • Установите пакет NuGet с помощью консоли диспетчера пакетов.
  • Установите Aspose.HTML для .NET через MSI.

Aspose.HTML для .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 для .NET DLL, на который есть ссылка в вашем проекте – установите из NuGet с помощью кнопки «Загрузить» выше.