Comment créer un paragraphe 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.
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.


Comment ajouter un paragraphe 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. La création d’un élément de paragraphe MD en C# a une fonctionnalité. La caractéristique est que le paragraphe doit être assemblé à partir de plusieurs nœuds, tels que des nœuds de texte, des espaces entre les nœuds de texte et une ligne vide après le paragraphe. Regardons comment créer un nouveau document Markdown à partir de zéro et y ajouter deux paragraphes.

Code C# pour éditer les fichiers MD

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

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

    // Add texts to the paragraph1
    paragraph1.AppendChild(mdf.Text("The first sentence of the first paragraph."));
    // Add a space after the first sentence in the paragraph through a special WhiteSpace node
    paragraph1.AppendChild(mdf.Whitespace());

    paragraph1.AppendChild(mdf.Text("The second sentence of the first paragraph."));

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

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

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

    // Add texts to the paragraph2
    paragraph2.AppendChild(mdf.Text("The first sentence of the second paragraph."));
    // Add a space after the first sentence in the paragraph through a special WhiteSpace node
    paragraph2.AppendChild(mdf.Whitespace());

    paragraph2.AppendChild(mdf.Text("The second sentence of the second paragraph."));

    // Add newLineTrivia element for an empty line after paragraph2
    paragraph2.GetTrailingTrivia().Add(newLineTrivia);

    // Add the filled paragraph2 into MD document as a last child
    md.AppendChild(paragraph2);

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

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



Étapes pour créer un paragraphe Markdown en C#

Nous vous rappelons que le paragraphe doit être assemblé à partir des nœuds composants. Envisagez des étapes simples pour créer un paragraphe Markdown:

  1. Créez un nouveau nœud de paragraphe vide à l’aide du constructeur Paragraph() dans SyntaxFactory.
  2. Utilisez le constructeur Text() pour créer des nœuds de texte pour le paragraphe.
  3. Appelez la méthode AppendChild() de la classe MarkdownSyntaxNode pour ajouter des nœuds de texte et des espaces dans le paragraphe.
  4. Utilisez le constructeur Whitespace() pour créer un espace entre les nœuds de texte dans le paragraphe.
  5. Créez et ajoutez un élément newLineTrivia pour une ligne vide après le paragraphe. Utilisez le constructeur NewLineTrivia() et la méthode Add().
  6. 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.

Ajouter un paragraphe Markdown en C#

L’exemple de code C# suivant montre comment ajouter un paragraphe dans un document MD existant:

Code C# pour ajouter un paragraphe

    // 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 syntaxTree = parser.ParseFile(input);

    // Get a SyntaxFactory to create new elements 
    var syntaxFactory = syntaxTree.SyntaxFactory;

    // Create a new empty paragraph 
    var paragraphSyntaxNode = syntaxFactory.Paragraph();

    // Create and add newLineTrivia element for an empty line after paragraph 
    var newLineTrivia = syntaxFactory.NewLineTrivia();
    paragraphSyntaxNode.GetTrailingTrivia().Add(newLineTrivia);
            
    // Create text content for the paragraph 
    var textSyntaxNode = syntaxFactory.Text("Markdown language is simple to learn. It has minimal extra characters, so you can quickly write and make fewer errors.");

    // Add text into paragraph
    paragraphSyntaxNode.AppendChild(textSyntaxNode);

    // Add paragraph to MD document before the first element of the syntax tree
    syntaxTree.InsertBefore(paragraphSyntaxNode, syntaxTree.FirstChild);

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

    // Save Markdown file
    syntaxTree.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

1. Comment puis-je créer, analyser et modifier Markdown en C#?

La bibliothèque Aspose.HTML pour .NET est une solution autonome pour travailler avec des documents Markdown qui ne dépend pas d’autres logiciels. Installez notre bibliothèque C#, ajoutez la référence de bibliothèque à votre projet C# et travaillez par programmation avec des documents Markdown.

2. Pourquoi Markdown est-il si populaire?

Markdown est très populaire parmi les écrivains, les développeurs et les créateurs de contenu en raison de sa polyvalence. Ses avantages incluent une syntaxe facile à apprendre et à utiliser, la portabilité, la flexibilité, la lisibilité et la convivialité. Markdown est simple et intuitif et peut être converti en HTML, PDF ou d’autres formats.

3. Puis-je travailler avec des fichiers Markdown sous Linux, Mac OS, Android ou iOS?

Vous pouvez travailler avec des documents Markdown sur n’importe quel système d’exploitation, que vous utilisiez Windows, Mac OS, Linux, Android ou iOS.

4. Quels formats de fichiers peuvent être traités avec la bibliothèque C# Aspose.HTML?

Nous prenons en charge plusieurs formats de fichiers que vous pouvez créer, ouvrir, analyser, modifier, enregistrer ou convertir en C#. Ce sont les formats HTML, XHTML, MHTML et Markdown.



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.