Listes Markdown en C#

Comment créer des listes Markdown en C#

La bibliothèque Aspose.HTML pour .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, en supprimant ou en modifiant le contenu des nœuds existants. Markdown prend en charge les listes ordonnées (numérotées) et non ordonnées (à puces). Dans cet article, vous découvrirez comment ajouter des listes dans Markdown à l’aide de la bibliothèque C#. Utilisez les espaces de noms Aspose.Html.Toolkit.Markdown.Syntax et Aspose.Html.Toolkit.Markdown.Parser pour fournir une analyse complète de Markdown et une gestion de l’arborescence de syntaxe MD basée sur GitHub Flavored Markdown (GFM ) spécification.

Créer une liste ordonnée 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 une liste ordonnée Markdown.

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

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

    // Create a new empty odered list node
    var orderedList = mdf.OrderedList();

    // Create and add to the odered list a li1 item with the marker “1”
    var li1 = mdf.OrderedListItem(1);
    orderedList.AppendChild(li1);

    // Create a paragraph with text content and add it to the li1 item
    var paragraph = mdf.Paragraph();

    var heading = mdf.AtxHeading("The first element in the Markdown ordered list is the level 3 heading.", 3);
    paragraph.AppendChild(heading);
    li1.AppendChild(paragraph);

    //Create and add to the odered list a li2 item with the marker “2”
    var li2 = mdf.OrderedListItem(2);
    orderedList.AppendChild(li2);

    // Create a strong emphasis with text content and add it to the li2 item
    var bold = mdf.Emphasis(Emphasis.Strong);

    bold.AppendChild(mdf.Text("The second item in the Markdown ordered list is in bold."));
    li2.AppendChild(bold);

    // Add orderedList to MD syntax tree
    md.AppendChild(orderedList);

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

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

Étapes pour créer une liste ordonnée Markdown en C#

Voici quelques étapes simples pour créer une liste ordonnée 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 nouveau nœud de liste ordonnée à l’aide du constructeur OderedList() dans SyntaxFactory.
4. Utilisez le constructeur OrderedListItem() pour créer de nouvelles instances de la classe ListItemSyntaxNode avec un marqueur d’élément de liste ordonnée.
5. Appelez la méthode AppendChild() de la classe MarkdownSyntaxNode pour ajouter des éléments de liste ordonnés dans le nœud liste ordonnée.
6. Une fois que tous les éléments avec leur contenu sont rassemblés dans un seul élément orderList, ajoutez-le à l’arborescence de syntaxe du document.

Créer une liste Markdown non ordonnée en C#

L’exemple de code C# suivant montre comment ajouter une liste non ordonnée au fichier MD:

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

    // Create a Markdown syntax factoty
    var mdf = md.SyntaxFactory;

    // Create a new empty unodered list node
    var unorderedList = mdf.UnorderedList();

    // Create and add to the unodered list a li1 element with the marker “-”
    var li1 = mdf.UnorderedListItem("-");
    unorderedList.AppendChild(li1);

    // Create a paragraph with text content and add it to the li1 item:
    var paragraph = mdf.Paragraph();
    paragraph.AppendChild(mdf.Text("The first item of the unordered Markdown list."));
    li1.AppendChild(paragraph);

    // Create and add to the unodered list a li2 element with the marker “-”
    var li2 = mdf.UnorderedListItem("-");
    unorderedList.AppendChild(li2);

    // Create a paragraph with text content and add it to the li2 item:
    var paragraph2 = mdf.Paragraph();
    paragraph2.AppendChild(mdf.Text("The second item of the unordered Markdown list."));
    li2.AppendChild(paragraph2);

    // Add unorderedList to MD syntax tree
    md.AppendChild(unorderedList);

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

    // Save MD file
    md.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

Premiers pas avec l'API HTML .NET

Vous pouvez utiliser plusieurs méthodes pour installer la bibliothèque Aspose.HTML pour .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 pour .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 pour .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 pour .NET DLL référencé dans votre projet – Installez à partir de NuGet en utilisant le bouton Télécharger ci-dessus.