Criar Markdown em C#

Como criar Markdown em C#

Markdown é uma linguagem de marcação simples que permite formatar texto simples. 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, abrir a partir de um arquivo local e manipular inserindo novos elementos, removendo ou editando o conteúdo de nós existentes.
O namespace Aspose.Html.Toolkit.Markdown.Syntax contém classes e métodos para manipular uma árvore de sintaxe Markdown com base na especificação GitHub Flavored Markdown (GFM).
O namespace Aspose.Html.Toolkit.Markdown.Parser contém classes e métodos para fornecer análise Markdown completa e renderização.
O namespace Aspose.Html.Toolkit.Markdown.Extensions contém classes e métodos para manipular a árvore de sintaxe Markdown com base em especificações que não fazem parte da especificação GFM.

Como criar Markdown do zero em C#?

Usando a biblioteca C#, você pode criar arquivos MD programaticamente. Vejamos como criar Markdown do zero.

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

Etapas para criar Markdown em C#

Vamos dar uma olhada nas etapas simples para criar o Markdown do zero. As duas primeiras etapas são obrigatórias para a criação do Markdown. As próximas etapas são adicionar novos elementos e salvar o documento:

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 e adicione novos elementos a um arquivo Markdown.
4. Salve o arquivo MD criado usando o método Save().

Como abrir arquivo MD em C#

O seguinte exemplo de código C# mostra como abrir um documento MD existente:

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

Documentação

Para saber mais sobre a API Aspose.HTML, visite nosso guia de documentação. O artigo de documentação Sintaxe Markdown fornece informações sobre os principais elementos Markdown, detalhes e exemplos da sintaxe Markdown.

Os arquivos MD usam a linguagem Markdown que foi proposta e desenvolvida por John Gruber. John Gruber projetou a sintaxe de formatação do Markdown com o objetivo de torná-la o mais legível possível. O Markdown é frequentemente usado como um formato para documentação e arquivos leia-me, pois permite escrever em um estilo fácil de ler e fácil de escrever. Além disso, os arquivos MD podem ser convertidos em HTML, PDF, XPS ou imagens para aproveitar outros formatos para tarefas específicas.

Instalar o Aspose.HTML for .NET

Instale o Aspose.HTML for .NET pelo NuGet usando a CLI do .NET:

dotnet add package Aspose.HTML

Você também pode usar a interface do Gerenciador de Pacotes NuGet ou executar Install-Package Aspose.HTML no Console do Gerenciador de Pacotes. Consulte o guia de instalação para configurar a biblioteca ou solicite uma licença temporária para avaliar a API sem limitações.

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.