API C# pour analyser les fichiers Markdown

Analyser les fichiers Markdown à l'aide de C#

La bibliothèque Aspose.HTML for .NET fournit l’API d’analyse Markdown pour la plate-forme C#. L’espace de noms Aspose.Html.Toolkit.Markdown.Parser contient des classes et des méthodes pour fournir une analyse et un rendu Markdown complets.

Vous pouvez créer, modifier, enregistrer, fusionner, convertir des fichiers MD vers d’autres formats de fichiers et ajouter des liens, des listes, des blocs de code, des images et d’autres éléments dans les fichiers Markdown en suivant les liens :

Comment analyser Markdown en C#

La tâche d’édition de Markdown par programmation en C# consiste à modifier des éléments dans l’arborescence de documents MD. L’API Aspose.HTML for .NET prend en charge un ensemble d’éléments MD qui sont définis dans GitHub Flavored Markdown Spec, ainsi que des règles sur la façon dont les éléments peuvent être imbriqués. De plus, l’espace de noms Aspose.Html.Toolkit.Markdown.Extensions contient des classes et des méthodes pour manipuler l’arbre de syntaxe Markdown en fonction de spécifications qui ne font pas partie de la spécification GFM. Envisagez des étapes simples pour analyser et modifier Markdown. Analysons Markdown et modifions-y le contenu textuel :

    // 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);
    
    // Create a TreeWalker object and navigate through the syntax tree starting at the first node
    using var iterator = markdown.CreateTreeWalker(markdown.FirstChild);
    while (iterator.NextNode() != null)
    {
        // Check the type of the current node as EmphasisSyntax
        if (iterator.CurrentNode is EmphasisSyntaxNode)
        {
            var node = (EmphasisSyntaxNode)iterator.CurrentNode;
            var n = node.FirstChild;
            while (n != null)
            {
                var next = n.NextSibling;
                // Remove the EmphasisSyntax node
                node.RemoveChild(n);
                n = next;
            }

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

            // Add the text to a new node
            node.AppendChild(syntax.Text("new text with"));

            // Add whitespase
            node.AppendChild(syntax.Whitespace());

            // Create an emphasis object
            var emphasis = syntax.Emphasis(Emphasis.Strong);

            // Add the text into empasis and accumulate a new node
            emphasis.AppendChild(syntax.Text("strong emphasis!"));
            node.AppendChild(emphasis);
            break;
        }
    }

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

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

Étapes pour analyser et modifier Markdown en C#

Envisagez des étapes simples pour analyser Markdown et modifier le contenu textuel existant :

1. Spécifiez le chemin d’accès au fichier MD source et utilisez le constructeur MarkdownParser() pour initialiser une nouvelle instance de la classe MarkdownParser.
2. Appelez la méthode ParseFile() pour analyser Markdown et obtenir un arbre de syntaxe.
3. Créez un objet TreeWalker et naviguez dans l’arborescence de syntaxe Markdown et supprimez le contenu inutile – nœud EmphasisSyntax.
4. Utilisez la propriété SyntaxFactory pour obtenir une fabrique de syntaxe pour créer de nouveaux éléments.
5. Créez un nouveau nœud de texte et ajoutez du contenu textuel à la nouvelle emphase.
6. Utilisez la méthode AppendChild() pour ajouter le nouveau nœud à l’arbre de syntaxe.
7. Enregistrez le fichier MD édité avec la méthode Save() .

Documentation

Pour en savoir plus sur l’API Aspose.HTML, veuillez consulter notre documentation guide. Vous pouvez télécharger les exemples depuis le dépôt GitHub . Ils sont open source et peuvent être librement utilisés dans vos propres applications.

Markdown est un langage de balisage simple qui vous permet de formater du texte brut. John Gruber, l’auteur de MD, a conçu la syntaxe de formatage de Markdown dans le but de la rendre aussi lisible que possible. Markdown est souvent utilisé comme format pour la documentation et les fichiers readme car il permet d’écrire dans un style facile à lire et à écrire. 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.

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.