Створити Markdown на C#

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

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

Як створити Markdown з нуля на C#?

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

    // 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;

    var heading2 = mdf.AtxHeading("How to create Markdown from scratch in C#?", 2);

    // Add the  headers to the Markdown syntax tree
    md.AppendChild(heading2);

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

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

    // Add texts to the paragraph
    paragraph.AppendChild(mdf.Text("First, add an Aspose.HTML for .NET library reference to your C# project."));

    // Add a space after the first sentence in the paragraph through a special WhiteSpace node
    paragraph.AppendChild(mdf.Whitespace());

    paragraph.AppendChild(mdf.Text("Create the MarkdownSyntaxTree. Then use the SyntaxFactory property to get a syntax factory to create new elements."));

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

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

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

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

Давайте розглянемо прості кроки, щоб створити Markdown з нуля. Перші два кроки є обов’язковими для створення Markdown. Наступними кроками є додавання нових елементів і збереження документа:

1. Створіть MarkdownSyntaxTree за допомогою конструктора MarkdownSyntaxTree().
2. Використовуйте властивість SyntaxFactory, щоб отримати фабрику для створення синтаксичного дерева Markdown.
3. Створіть і додайте нові елементи до файлу Markdown.
4. Збережіть створений файл MD за допомогою методу Save().

Як відкрити файл MD на C#

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

    // 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);

    // Work with Markdown document

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

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

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

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

Файли MD використовують мову Markdown, запропоновану та розроблену Джоном Грубером. Джон Грубер розробив синтаксис форматування Markdown з метою зробити його максимально читабельним. Markdown часто використовується як формат для документації та файлів readme, оскільки він дозволяє писати в стилі, який легко читати та писати. Крім того, файли MD можна конвертувати у HTML, PDF, XPS або зображення, щоб скористатися перевагами інших форматів для конкретних завдань.

Установлення 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» вище.