En-tête Markdown en C#

Comment créer un en-tête Markdown en C#

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, 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 en-tête 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 d’en-tête Markdown en C# a une fonctionnalité. La fonctionnalité est que l’en-tête 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 l’en-tête. Regardons comment créer un nouveau document Markdown à partir de zéro et y ajouter des en-têtes.

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

    // Get a SyntaxFactory to create new elements
    var mdf = markdown.SyntaxFactory;

    // Create headings of the required level
    var heading1 = mdf.AtxHeading("Heading 1 level text", 1);
    var heading2 = mdf.AtxHeading("Heading 2 level text", 2);
    var heading3 = mdf.AtxHeading("Heading 3 level text", 3);

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

    // Add the headers to the Markdown syntax tree
    markdown.AppendChild(heading1);
    markdown.AppendChild(heading2);
    markdown.AppendChild(heading3);

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

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

Étapes pour créer un en-tête Markdown en C#

Considérons les étapes simples pour créer un en-tête Markdown:

1. 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.
2. Créez un élément newLineTrivia pour une ligne vide après l’en-tête. Utilisez le constructeur NewLineTrivia() .
3. Appelez la méthode Add() de la classe SyntaxNodeCollection pour ajouter le nœud newLineTrivia dans l’élément d’en-tête.
4. 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.

Modifier l'en-tête Markdown en C#

L’exemple de code C# suivant montre comment modifier l’en-tête Markdown dans un document MD existant:

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

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

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

    // The first element of this document is AtxHeading
    var heading = (AtxHeadingSyntaxNode)syntaxTree.FirstChild;

    // Accumulate the text content from its elements
    var sb = new StringBuilder();

    while (heading.FirstChild != null)
    {
        sb.Append(heading.FirstChild);

        //  Remove accumulated first element from the tree
        heading.RemoveChild(heading.FirstChild);
    }

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

    // Сreate a text node consisting of new and old text and add it as a child element of AtxHeading 
    var textSyntaxNode = syntaxFactory.Text("Added some new text! " + sb);
            
    // Add the new element to the document tree
    heading.AppendChild(textSyntaxNode);

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

    // Save MD 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

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.