Encabezado (Header) Markdown en C#

Cómo crear un encabezado Markdown en C#

La biblioteca Aspose.HTML for .NET es una solución independiente que le permite analizar y manipular archivos Markdown sin usar otro software. Puede crear un documento Markdown desde cero, abrirlo desde un archivo local y manipularlo insertando nuevos elementos, eliminando o editando el contenido de los nodos existentes.
Utilice Aspose.Html.Toolkit.Markdown.Syntax y Aspose.Html.Toolkit.Markdown.Parser espacios de nombres para proporcionar un análisis completo de Markdown y administración de árbol de sintaxis MD basada en la especificación GitHub Flavored Markdown (GFM).

Cómo agregar un encabezado Markdown en C#

Con la biblioteca de C#, puede editar archivos MD mediante programación: cambiar la estructura y el contenido del documento. La creación de un elemento de encabezado Markdown en C# tiene una característica. La característica es que el encabezado debe ensamblarse a partir de varios nodos, como nodos de texto, espacios entre los nodos de texto y una línea vacía después del encabezado. Veamos cómo crear un nuevo documento Markdown desde cero y agregarle encabezados.

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

Pasos para crear un encabezado Markdown en C#

Consideremos los pasos simples para crear un encabezado Markdown:

1. Cree un nuevo encabezado usando AtxHeading(string, int) constructor del MarkdownSyntaxFactory clase. Crea AtxHeadingSyntaxNode con contenido de texto y nivel de título.
2. Cree un elemento newLineTrivia para una línea vacía después del encabezado. Utilice el constructor NewLineTrivia().
3. Llame al método Add() de la clase SyntaxNodeCollection para agregar el nodo newLineTrivia al elemento de encabezado.
4. Después de que todos los nodos de encabezado se hayan recopilado en un elemento, agréguelo al árbol de sintaxis del documento.

Edite el encabezado Markdown en un archivo MD existente en C#

El siguiente ejemplo de código C# muestra cómo editar el encabezado Markdown en un documento MD existente:

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

Documentación

Para obtener más información sobre la API de Aspose.HTML, visite nuestra guía documentación. Markdown es un lenguaje de marcado simple que le permite formatear texto sin formato. El artículo de documentación Sintaxis de Markdown proporciona información sobre los elementos principales de Markdown, detalles y ejemplos de la sintaxis de Markdown.

FAQ

Introducción a la API HTML de .NET

Puede usar varias formas de instalar la biblioteca Aspose.HTML para .NET en su sistema:

1. Instale un Paquete NuGet mediante la GUI del Administrador de paquetes NuGet.
2. Instale un paquete NuGet mediante la Consola del administrador de paquetes. Puede usar el siguiente comando PM> Install-Package Aspose.Html.
3. Instale Aspose.HTML para .NET a través de MSI.
   

Esta biblioteca admite el análisis de HTML5, CSS3, SVG y HTML Canvas para construir un modelo de objeto de documento (DOM) basado en el estándar WHATWG DOM. Aspose.HTML para .NET está escrito completamente en C# y se puede usar para crear cualquier tipo de aplicación .NET de 32 o 64 bits, incluidos ASP.NET, WCF, WinForms y .NET Core. Antes de ejecutar el código de ejemplo de conversión de .NET, asegúrese de tener un sistema operativo como Microsoft Windows o compatible con .NET Framework o .NET Standard, y el entorno de desarrollo como Microsoft Visual Studio. Para obtener más detalles sobre la instalación de la biblioteca de C# y los requisitos del sistema, consulte Documentación de Aspose.HTML.

Requisitos del sistema

Nuestras API son compatibles con todas las principales plataformas y sistemas operativos. Antes de ejecutar el código, asegúrese de tener los siguientes requisitos previos en su sistema.

• Microsoft Windows o un sistema operativo compatible con las plataformas .NET Framework, .NET Core, Windows Azure, Mono o Xamarin.
• Entorno de desarrollo como Microsoft Visual Studio.
• Aspose.Html para .NET DLL a la que se hace referencia en su proyecto – Instale desde NuGet usando el botón Descargar de arriba.