Créer Markdown en C#

Comment créer Markdown en C#

Markdown est un langage de balisage simple qui vous permet de formater du texte brut. 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.
L’espace de noms Aspose.Html.Toolkit.Markdown.Syntax contient des classes et des méthodes pour manipuler un arbre de syntaxe Markdown basé sur la spécification GitHub Flavored Markdown (GFM).
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.
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.

Comment créer Markdown à partir de zéro en C#?

À l’aide de la bibliothèque C#, vous pouvez créer par programme des fichiers MD. Voyons comment créer Markdown à partir de zéro.

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

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

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

    // 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("Create the MarkdownSyntaxTree. Then 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, "document.md");

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

Étapes pour créer Markdown en C#

Jetons un coup d’œil aux étapes simples pour créer Markdown à partir de zéro. Les deux premières étapes sont obligatoires pour la création de Markdown. Les étapes suivantes consistent à ajouter de nouveaux éléments et à enregistrer le document :

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 et ajoutez de nouveaux éléments à un fichier Markdown.
4. Enregistrez le fichier MD créé en utilisant la méthode Save() .

Comment ouvrir un fichier MD en C#

L’exemple de code C# suivant montre comment ouvrir un document MD existant:

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

    // Work with Markdown document

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

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

Documentation

Pour en savoir plus sur l’API Aspose.HTML, veuillez consulter notre documentation guide. 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.

Les fichiers MD utilisent le langage Markdown qui a été proposé et développé par John Gruber. John Gruber 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. De plus, les fichiers MD peuvent être convertis en HTML, PDF, XPS ou images pour tirer parti d’autres formats pour des tâches spécifiques.

Installer Aspose.HTML for .NET

Installez Aspose.HTML for .NET depuis NuGet avec l’interface CLI .NET :

dotnet add package Aspose.HTML

Vous pouvez également utiliser l’interface du gestionnaire de packages NuGet ou exécuter Install-Package Aspose.HTML dans la console du gestionnaire de packages. Consultez le guide d’installation pour la configuration, ou demandez une licence temporaire afin d’évaluer l’API sans limitations.

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.