Markdown Text et Markdown Blockquote en C#

Comment créer du texte Markdown en C#

Comme HTML, Markdown est un langage de balisage. Contrairement au HTML, Markdown vise à être aussi lisible que possible. Vous pouvez appliquer du gras, de l’italique, des guillemets et du barré au texte. Ils peuvent également être utilisés en combinaison pour utiliser plusieurs styles en même temps. La bibliothèque Aspose.HTML for .NET est une solution autonome qui vous permet d’analyser et de manipuler des fichiers Markdown sans utiliser d’autres logiciels. Vous pouvez créer un document Markdown à partir de zéro, l’ouvrir à partir d’un fichier local et le manipuler en insérant de nouveaux éléments et en supprimant ou en modifiant le contenu des nœuds existants.

La classe MarkdownSyntaxFactory contient des méthodes pour créer divers éléments Markdown. Pour la création d’en-têtes, vous pouvez utiliser la méthode AtxHeading() qui crée un nœud de syntaxe d’en-tête Atx avec un contenu textuel. Vous pouvez utiliser la méthode Emphasis() qui prend comme paramètre les valeurs d’énumération Emphasis pour mettre le texte en gras ou en italique, et plus encore. Nous examinons ici quelques exemples C# de la façon de travailler avec du texte Markdown.

Texte Markdown en C#

À l’aide de la bibliothèque C#, vous pouvez modifier par programmation des fichiers MD – modifier la structure et le contenu du document. Regardons comment créer un nouveau document Markdown à partir de zéro et y ajouter des textes.

// 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 header = mdf.AtxHeading("How to create Markdown Text in C#?", 2);

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

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

    // 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("Then create the Markdown Syntax Tree and 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, "markdown-text.md");

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

Étapes pour créer du texte Markdown en C#

Considérons quelques étapes simples pour créer des textes Markdown:

1. Créez le MarkdownSyntaxTree à l’aide du constructeur MarkdownSyntaxTree() .
2. Utilisez la propriété SyntaxFactory pour obtenir la fabrique permettant de créer l’arbre de syntaxe Markdown.
3. Créez un nouvel en-tête à l’aide du constructeur AtxHeading(string, int) de la classe MarkdownSyntaxFactory . Il crée AtxHeadingSyntaxNode avec un contenu textuel et un niveau d’en-tête.
4. Créez un élément newLineTrivia pour une ligne vide après l’en-tête. Utilisez le constructeur NewLineTrivia() .
5. Appelez la méthode Add() de la classe SyntaxNodeCollection pour ajouter le nœud newLineTrivia dans l’élément d’en-tête.
6. Une fois que tous les nœuds d’en-tête ont été rassemblés dans un élément, ajoutez-le à l’arborescence de syntaxe du document.
7. Créez un nouveau nœud de paragraphe vide à l’aide du constructeur Paragraph() dans SyntaxFactory.
8. Utilisez le constructeur Text() pour créer des nœuds de texte pour le paragraphe.
9. Utilisez le constructeur Whitespace() pour créer un espace entre les nœuds de texte dans le paragraphe.
10. Appelez la méthode AppendChild() de la classe MarkdownSyntaxNode pour ajouter des nœuds de texte et des espaces dans le paragraphe.
11. Une fois que tous les nœuds de paragraphe ont été rassemblés dans un élément, ajoutez-le à l’arborescence de syntaxe du document. Appelez la méthode AppendChild() de la classe MarkdownSyntaxNode.

Créer une citation de bloc Markdown en C#

L’exemple de code C# suivant montre comment créer un blockquote Markdown.

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

    // Create a Markdown syntax factory
    var mdf = markdown.SyntaxFactory;

    // Create a blockQuote object
    var blockQuote = mdf.BlockQuote();

    // Add a leading trivia token blockquote
    blockQuote.GetLinesLeadingTrivia().Add(mdf.Token(SourceText.From("> ")));

    // Create a paragraph with text content
    var paragraph = mdf.Paragraph();
    paragraph.AppendChild(mdf.Text("For blockquote creation, you should put a sign `>` before the first line of a hard-wrapped paragraph.."));

    // Add paragraph into blockQuote
    blockQuote.AppendChild(paragraph);

    // Add blockQuote object into MD document
    markdown.AppendChild(blockQuote);

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

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

Documentation

Pour en savoir plus sur l’API Aspose.HTML, veuillez consulter notre documentation guide. Markdown est un langage de balisage simple qui vous permet de formater du texte brut. L’article de documentation Markdown Syntax fournit des informations sur les principaux éléments Markdown, des détails et des exemples de la syntaxe Markdown.

FAQ

Démarrer avec l'API Aspose.HTML for .NET

Vous pouvez utiliser plusieurs méthodes pour installer la bibliothèque Aspose.HTML for .NET sur votre système :

1. Installez un package NuGet à l’aide de l’interface graphique du gestionnaire de packages NuGet.
2. Installez un package NuGet à l’aide de la console du gestionnaire de packages. Vous pouvez utiliser la commande suivante PM> Install-Package Aspose.Html.
3. Installez Aspose.HTML for .NET via MSI.
   

Cette bibliothèque prend en charge l’analyse de HTML5, CSS3, SVG et HTML Canvas pour construire un modèle d’objet de document (DOM) basé sur la norme WHATWG DOM. Aspose.HTML for .NET est entièrement écrit en C# et peut être utilisé pour créer tout type d’application .NET 32 bits ou 64 bits, y compris ASP.NET, WCF, WinForms et .NET Core. Avant d’exécuter l’exemple de code de conversion .NET, assurez-vous que vous disposez d’un système d’exploitation tel que Microsoft Windows ou compatible avec .NET Framework ou .NET Standard, et d’un environnement de développement tel que Microsoft Visual Studio. Pour plus de détails sur l’installation de la bibliothèque C# et la configuration système requise, veuillez consulter Aspose.HTML Documentation.

Configuration requise

Nos API sont prises en charge sur toutes les principales plates-formes et systèmes d’exploitation. Avant d’exécuter le code, assurez-vous que vous disposez des prérequis suivants sur votre système.

• Microsoft Windows ou un système d’exploitation compatible avec les plates-formes .NET Framework, .NET Core, Windows Azure, Mono ou Xamarin.
• Environnement de développement comme Microsoft Visual Studio.
• Aspose.HTML for .NET DLL référencé dans votre projet – Installez à partir de NuGet en utilisant le bouton Télécharger ci-dessus.