Como criar código embutido Markdown ou bloco de código em C#

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.
Use o Aspose.Html.Toolkit.Markdown.Syntax e Aspose.Html.Toolkit.Markdown.Parser namespaces para fornecer análise Markdown completa e gerenciamento de árvore de sintaxe MD com base na especificação GitHub Flavored Markdown (GFM).


Como adicionar código embutido Markdown em C#

Usando a biblioteca C#, você pode editar arquivos MD programaticamente – altere a estrutura e o conteúdo do documento. A criação de um código embutido Markdown ou bloco de código Markdown em C# tem um recurso, que o elemento CodeSpan ou FencedCodeBlock precisa ser montado a partir de vários nós, como nós de texto, espaços entre nós de texto ou uma linha vazia após o nó.
Vejamos como criar um documento Markdown do zero e adicionar código embutido a ele.

Código C# para adicionar código embutido ao arquivo MD

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

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

    // Create an empty codeSpan node
    var codeSpan = mdf.CodeSpan();

    // Create text content for the codeSpan
    codeSpan.AppendChild(mdf.Text("Source code text"));

    // Add codeSpan to MD document
    markdown.AppendChild(codeSpan);

    // Add a space after the code node through a special WhiteSpace node
    markdown.AppendChild(mdf.Whitespace());

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

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



Etapas para criar código Markdown em C#

Lembramos que o código inline precisa ser montado a partir dos nós componentes. Considere as etapas simples para criar o código inline Markdown:

  1. Crie um novo nó CodeSpan vazio usando o construtor CodeSpan() em SyntaxFactory.
  2. Use o construtor Text() para criar nós de texto para o CodeSpan.
  3. Chame o método AppendChild() da classe MarkdownSyntaxNode para adicionar nós de texto na Elemento CodeSpan.
  4. Adicione o bloco de código criado à árvore de sintaxe do documento usando o método AppendChild().
  5. Use o construtor Whitespace() para criar espaço após o código embutido.

Adicionar bloco de código Markdown em C#

O exemplo de código C# a seguir mostra como adicionar o bloco de código Markdown ao documento MD:

Código C# para adicionar o bloco de código Markdown

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

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

    // Create a start token and an end token that will frame a code block
    var startToken = mdf.Token(SourceText.From("```\r\n"));
    var endToken = mdf.Token(SourceText.From("\r\n```"));

    // Create a fenced code element
    var fencedCodeSpan = mdf.FencedCodeBlock(startToken, null, endToken);

    // Create text content for the fenced code element
    fencedCodeSpan.AppendChild(mdf.Text("Source code text"));

    //Add the fenced code element to MD file
    markdown.AppendChild(fencedCodeSpan);
            
    // Prepare a path for MD file saving 
    string savePath = Path.Combine(OutputDir, "markdown-code-block.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.


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.