Создать 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);

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

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

Статья документации Синтаксис Markdown содержит информацию об основных элементах Markdown, подробности и примеры синтаксиса Markdown.

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

FAQ

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

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

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

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