Crear Markdown en C#

Cómo crear Markdown en C#

Markdown es un lenguaje de marcado simple que le permite formatear texto sin formato. 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.
El espacio de nombres Aspose.Html.Toolkit.Markdown.Syntax contiene clases y métodos para manipular un árbol de sintaxis Markdown basado en en GitHub Flavored Markdown (GFM) Especificación.
El espacio de nombres Aspose.Html.Toolkit.Markdown.Parser contiene clases y métodos para proporcionar un análisis completo de Markdown y renderizado.
El espacio de nombres Aspose.Html.Toolkit.Markdown.Extensions contiene clases y métodos para manipular el árbol de sintaxis de Markdown basado en sobre especificaciones que no forman parte de la especificación GFM.

¿Cómo crear Markdown desde cero en C#?

Con la biblioteca de C#, puede crear archivos MD mediante programación. Veamos cómo crear Markdown desde cero.

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

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

    var heading2 = mdf.AtxHeading("How to create Markdown from scratch in C#?", 2);

    // Add the  headers to the Markdown syntax tree
    md.AppendChild(heading2);

    // Create and add newLineTrivia element for an empty line after heading1 
    var newLineTrivia = mdf.NewLineTrivia();
    heading2.GetTrailingTrivia().Add(newLineTrivia);

    // Create an empty paragraph
    var paragraph = mdf.Paragraph();

    // Add texts to the paragraph
    paragraph.AppendChild(mdf.Text("First, add an Aspose.HTML for .NET library reference to your C# project."));

    // Add a space after the first sentence in the paragraph through a special WhiteSpace node
    paragraph.AppendChild(mdf.Whitespace());

    paragraph.AppendChild(mdf.Text("Create the MarkdownSyntaxTree. Then use the SyntaxFactory property to get a syntax factory to create new elements."));

    // Add the filled paragraph into MD document
    md.AppendChild(paragraph);

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

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

Pasos para crear Markdown en C#

Echemos un vistazo a los sencillos pasos para crear Markdown desde cero. Los dos primeros pasos son obligatorios para la creación de Markdown. Los siguientes pasos son agregar nuevos elementos y guardar el documento:

1. Cree MarkdownSyntaxTree usando el constructor MarkdownSyntaxTree().
2. Use la propiedad SyntaxFactory para obtener la fábrica para crear el árbol de sintaxis Markdown.
3. Cree y agregue nuevos elementos a un archivo Markdown.
4. Guarde el archivo MD creado usando el método Save().

Cómo abrir un archivo MD en C#

El siguiente ejemplo de código C# muestra cómo abrir un documento MD existente:

    // Specify the path to the source MD file
    var input = "C:/temp/input.md";

    // Create a MarkdownParser object
    var parser = new MarkdownParser();

    // Parse the MD document and get a syntax tree
    var markdown = parser.ParseFile(input);

    // Work with Markdown document

    // Prepare a path for MD file saving 
    string savePath = Path.Combine(OutputDir, "output.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. 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.

Los archivos MD utilizan el lenguaje Markdown propuesto y desarrollado por John Gruber. John Gruber diseñó la sintaxis de formato de Markdown con el objetivo de hacerla lo más legible posible. Markdown se usa a menudo como formato para documentación y archivos Léame, ya que permite escribir en un estilo fácil de leer y escribir. Además, los archivos MD se pueden convertir a HTML, PDF, XPS o imágenes para aprovechar otros formatos para tareas específicas.

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.