Como criar texto Markdown em C#

Como HTML, Markdown é uma linguagem de marcação. Ao contrário do HTML, o Markdown visa ser o mais legível possível. Você pode aplicar negrito, itálico, aspas e tachado ao texto. Eles também podem ser usados ​​em combinação para usar vários estilos ao mesmo tempo. A biblioteca Aspose.HTML for .NET é uma solução independente que permite analisar e manipular arquivos Markdown sem usar outro software. Você pode criar um documento Markdown do zero, abri-lo a partir de um arquivo local e manipulá-lo inserindo novos elementos e removendo ou editando o conteúdo dos nós existentes.

A classe MarkdownSyntaxFactory contém métodos para criar vários elementos Markdown. Para criação de cabeçalhos, você pode usar o método AtxHeading() que cria o cabeçalho Atx Nó de sintaxe com conteúdo de texto. Você pode usar o método Emphasis() que toma como parâmetro a enumeração Emphasis valores para tornar o texto em negrito ou itálico e muito mais. Aqui, veremos alguns exemplos em C# de como trabalhar com o texto Markdown.


Texto de Markdown em C#

Usando a biblioteca C#, você pode editar arquivos MD programaticamente – altere a estrutura e o conteúdo do documento. Vejamos como criar um novo documento Markdown do zero e adicionar textos a ele.

Código C# para criar texto 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 header = mdf.AtxHeading("How to create Markdown Text in C#?", 2);

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

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

    // 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("Then create the Markdown Syntax Tree and 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, "markdown-text.md");

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



Etapas para criar texto de Markdown em C#

  1. Vamos considerar alguns passos simples para criar textos Markdown:1. Crie o MarkdownSyntaxTree usando o construtor MarkdownSyntaxTree() .
  2. Use a propriedade SyntaxFactory para obter a fábrica para criar a árvore de sintaxe Markdown.
  3. Crie um novo cabeçalho usando o construtor AtxHeading(string, int) do MarkdownSyntaxFactory classe. Ele cria AtxHeadingSyntaxNode com conteúdo de texto e nível de título.
  4. Crie um elemento newLineTrivia para uma linha vazia após o cabeçalho. Use o construtor NewLineTrivia() .
  5. Chame o método Add() da classe SyntaxNodeCollection para adicionar o nó newLineTrivia ao elemento de cabeçalho.
  6. Após todos os nós de cabeçalho terem sido coletados em um elemento, adicione-o à árvore de sintaxe do documento.
  7. Crie um novo nó de parágrafo vazio usando o construtor Paragraph() em SyntaxFactory.
  8. Use o construtor Text() para criar nós de texto para o parágrafo.
  9. Use o construtor Whitespace() para criar espaço entre nós de texto no parágrafo .
  10. Chame o método AppendChild() da classe MarkdownSyntaxNode para adicionar nós de texto e espaços em branco em parágrafo.
  11. Após todos os nós de parágrafo terem sido coletados em um elemento, adicione-o à árvore de sintaxe do documento. Chame o método AppendChild() da classe MarkdownSyntaxNode.

Criar Blockquote Markdown em C#

O exemplo de código C# a seguir mostra como criar blockquote Markdown.

Código C# para adicionar blockquote de Markdown

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

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

    // Create a blockQuote object
    var blockQuote = mdf.BlockQuote();

    // Add a leading trivia token blockquote
    blockQuote.GetLinesLeadingTrivia().Add(mdf.Token(SourceText.From("> ")));

    // Create a paragraph with text content 
    var paragraph = mdf.Paragraph();
    paragraph.AppendChild(mdf.Text("For blockquote creation, you should put a sign `>` before the first line of a hard-wrapped paragraph.."));

    // Add paragraph into blockQuote
    blockQuote.AppendChild(paragraph);

    // Add blockQuote object into MD document
    markdown.AppendChild(blockQuote);

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

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

Documentação

Para saber mais sobre a API Aspose.HTML, visite nosso guia de documentação. Markdown é uma linguagem de marcação simples que permite formatar texto simples. O artigo de documentação Sintaxe Markdown fornece informações sobre os principais elementos Markdown, detalhes e exemplos da sintaxe Markdown.


Introdução à API Aspose.HTML for .NET

Você pode usar várias maneiras de instalar a biblioteca Aspose.HTML for .NET em seu sistema:

  1. Instale um Pacote NuGet usando a GUI do NuGet Package Manager.
  2. Instale um pacote NuGet usando o console do gerenciador de pacotes. Você pode usar o seguinte comando PM> Install-Package Aspose.Html.
  3. Instale o Aspose.HTML for .NET através do MSI.

Esta biblioteca suporta a análise de HTML5, CSS3, SVG e HTML Canvas para construir um Document Object Model (DOM) baseado no WHATWG DOM Standard. Aspose.HTML for .NET foi totalmente escrito em C# e pode ser usado para criar qualquer tipo de aplicativo .NET de 32 ou 64 bits, incluindo ASP.NET, WCF, WinForms e .NET Core. Antes de executar o código de exemplo de conversão .NET, certifique-se de ter um sistema operacional como o Microsoft Windows ou compatível com .NET Framework ou .NET Standard e o ambiente de desenvolvimento como o Microsoft Visual Studio. Para obter mais detalhes sobre a instalação da biblioteca C# e os requisitos do sistema, consulte Documentação do Aspose.HTML.


Requisitos de sistema

Nossas APIs são suportadas em todas as principais plataformas e sistemas operacionais. Antes de executar o código, verifique se você possui os seguintes pré-requisitos em seu sistema.

  • Microsoft Windows ou um sistema operacional compatível com plataformas .NET Framework, .NET Core, Windows Azure, Mono ou Xamarin.
  • Ambiente de desenvolvimento como Microsoft Visual Studio.
  • Aspose.HTML for .NET DLL referenciado em seu projeto – Instale a partir do NuGet usando o botão Download acima.