Cómo crear código en línea Markdown o bloque de código 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 código en línea 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 código en línea Markdown o un bloque de código Markdown en C# tiene la característica de que el elemento CodeSpan o FencedCodeBlock debe ensamblarse a partir de varios nodos, como nodos de texto, espacios entre nodos de texto o una línea vacía después del nodo.
Veamos cómo crear un documento Markdown desde cero y agregarle código en línea.

Código C# para agregar código en línea al archivo 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);



Pasos para crear código Markdown en C#

Le recordamos que el código en línea debe ensamblarse a partir de los nodos de los componentes. Considere pasos simples para crear código en línea de Markdown:

  1. Cree un nuevo nodo CodeSpan vacío usando el constructor CodeSpan() en SyntaxFactory.
  2. Utilice el constructor Text() para crear nodos de texto para CodeSpan.
  3. Llame al método AppendChild() de la clase MarkdownSyntaxNode para agregar nodos de texto al Elemento CodeSpan.
  4. Agregue el bloque de código creado al árbol de sintaxis del documento utilizando el método AppendChild().
  5. Use el constructor Whitespace() para crear un espacio después del código en línea.

Agregar bloque de código Markdown al archivo MD en C#

El siguiente ejemplo de código C# muestra cómo agregar un bloque de código Markdown a un documento MD:

Código C# para agregar bloque 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);

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.


Instalar Aspose.HTML for .NET

Instale Aspose.HTML for .NET desde NuGet con la CLI de .NET:

dotnet add package Aspose.HTML

También puede usar la interfaz del Administrador de paquetes NuGet o ejecutar Install-Package Aspose.HTML en la consola del Administrador de paquetes. Consulte la guía de instalación para configurar la biblioteca o solicite una licencia temporal para evaluar la API sin limitaciones.

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 for .NET DLL a la que se hace referencia en su proyecto – Instale desde NuGet usando el botón Descargar de arriba.