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:
- Crie um novo nó CodeSpan vazio usando o construtor CodeSpan() em SyntaxFactory.
- Use o construtor Text() para criar nós de texto para o CodeSpan.
- Chame o método AppendChild() da classe MarkdownSyntaxNode para adicionar nós de texto na Elemento CodeSpan.
- Adicione o bloco de código criado à árvore de sintaxe do documento usando o método AppendChild().
- 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.
FAQ
A Biblioteca Aspose.HTML for .NET é uma solução autônoma para trabalhar com documentos Markdown que não dependem de outro software. Instale nossa biblioteca C#, adicione a referência da biblioteca ao seu projeto C# e trabalhe programaticamente com documentos Markdown.
Markdown é muito popular entre escritores, desenvolvedores e criadores de conteúdo devido à sua versatilidade. Suas vantagens incluem sintaxe fácil de aprender e usar, portabilidade, flexibilidade, legibilidade e usabilidade. Markdown é simples e intuitivo e pode ser convertido em HTML, PDF ou outros formatos.
Você pode trabalhar com documentos Markdown em qualquer sistema operacional, esteja usando Windows, Mac OS, Linux, Android ou iOS.
Oferecemos suporte a vários formatos de arquivo que você pode criar, abrir, analisar, editar, salvar ou converter em C#. Estes são os formatos HTML, XHTML, MHTML e 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:
- Instale um Pacote NuGet usando a GUI do NuGet Package Manager.
- Instale um pacote NuGet usando o console do gerenciador de pacotes. Você pode usar o seguinte comando
PM> Install-Package Aspose.Html
. - 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.