Como criar um cabeçalho Markdown 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 cabeçalho 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 elemento de cabeçalho Markdown em C# tem um recurso. O recurso é que o cabeçalho precisa ser montado a partir de vários nós, como nós de texto, espaços entre os nós de texto e uma linha vazia após o cabeçalho. Vamos ver como criar um novo documento Markdown do zero e adicionar cabeçalhos a ele.
Código C# para editar arquivos MD
// Create the MarkdownSyntaxTree
var markdown = new MarkdownSyntaxTree(new Configuration());
// Get a SyntaxFactory to create new elements
var mdf = markdown.SyntaxFactory;
// Create headings of the required level
var heading1 = mdf.AtxHeading("Heading 1 level text", 1);
var heading2 = mdf.AtxHeading("Heading 2 level text", 2);
var heading3 = mdf.AtxHeading("Heading 3 level text", 3);
// Create and add newLineTrivia element for an empty line after headings
var newLineTrivia = mdf.NewLineTrivia();
heading1.GetTrailingTrivia().Add(newLineTrivia);
heading2.GetTrailingTrivia().Add(newLineTrivia);
heading3.GetTrailingTrivia().Add(newLineTrivia);
// Add the headers to the Markdown syntax tree
markdown.AppendChild(heading1);
markdown.AppendChild(heading2);
markdown.AppendChild(heading3);
// Prepare a path for MD file saving
string savePath = Path.Combine(OutputDir, "output-headers.md");
// Save MD file
markdown.Save(savePath);
Etapas para criar um cabeçalho Markdown em C#
Vamos considerar as etapas simples para criar um cabeçalho Markdown:
- 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.
- Crie um elemento newLineTrivia para uma linha vazia após o cabeçalho. Use o construtor NewLineTrivia().
- Chame o método Add() da classe SyntaxNodeCollection para adicionar o nó newLineTrivia ao elemento de cabeçalho.
- Após todos os nós de cabeçalho terem sido coletados em um elemento, adicione-o à árvore de sintaxe do documento.
Editar cabeçalho Markdown em C#
O exemplo de código C# a seguir mostra como editar o cabeçalho Markdown em um documento MD existente:
Código C# para adicionar cabeçalho Markdown
// Specify the path to the source MD file
var input = "C:/temp/document.md";
// Create a MarkdownParser object
var parser = new MarkdownParser();
// Parse the document and get a Markdown syntax tree
var syntaxTree = parser.ParseFile(input);
// The first element of this document is AtxHeading
var heading = (AtxHeadingSyntaxNode)syntaxTree.FirstChild;
// Accumulate the text content from its elements
var sb = new StringBuilder();
while (heading.FirstChild != null)
{
sb.Append(heading.FirstChild);
// Remove accumulated first element from the tree
heading.RemoveChild(heading.FirstChild);
}
// Get a SyntaxFactory to create new elements
var syntaxFactory = syntaxTree.SyntaxFactory;
// Сreate a text node consisting of new and old text and add it as a child element of AtxHeading
var textSyntaxNode = syntaxFactory.Text("Added some new text! " + sb);
// Add the new element to the document tree
heading.AppendChild(textSyntaxNode);
// Prepare a path for MD file saving
string savePath = Path.Combine(OutputDir, "edit-header.md");
// Save MD file
syntaxTree.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.