Comment créer du code en ligne Markdown ou un bloc de code 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 du code en ligne 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 code en ligne Markdown ou d’un bloc de code Markdown en C# a une fonctionnalité selon laquelle l’élément CodeSpan ou FencedCodeBlock doit être assemblé à partir de plusieurs nœuds, tels que des nœuds de texte, des espaces entre les nœuds de texte ou une ligne vide après le nœud.
Regardons comment créer un document Markdown à partir de zéro et y ajouter du code en ligne.

Code C# pour ajouter du code en ligne au fichier MD

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

    // Use the SyntaxFactory property to get the factory for creating the Markdown syntax tree
    var mdf = markdown.SyntaxFactory;

    // Create an empty codeSpan node
    var codeSpan = mdf.CodeSpan();

    // Create text content for the codeSpan
    codeSpan.AppendChild(mdf.Text("Source code text"));

    // Add codeSpan to MD document
    markdown.AppendChild(codeSpan);

    // Add a space after the code node through a special WhiteSpace node
    markdown.AppendChild(mdf.Whitespace());

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

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



Étapes pour créer du code Markdown en C#

Nous vous rappelons que le code inline doit être assemblé à partir des nœuds composants. Envisagez des étapes simples pour créer du code en ligne Markdown :

  1. Créez un nouveau nœud CodeSpan vide à l’aide du constructeur CodeSpan() dans SyntaxFactory.
  2. Utilisez le constructeur Text() pour créer des nœuds de texte pour CodeSpan.
  3. Appelez la méthode AppendChild() de la classe MarkdownSyntaxNode pour ajouter des nœuds de texte dans l’élément CodeSpan.
  4. Ajoutez le bloc de code créé à l’arborescence de syntaxe du document à l’aide de la méthode AppendChild().
  5. Utilisez le constructeur Whitespace() pour créer un espace après le code en ligne.

Ajouter un bloc de code Markdown en C#

L’exemple de code C# suivant montre comment ajouter un bloc de code Markdown au document MD:

Code C# pour ajouter un bloc de code Markdown

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

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

    // Create a start token and an end token that will frame a code block
    var startToken = mdf.Token(SourceText.From("```\r\n"));
    var endToken = mdf.Token(SourceText.From("\r\n```"));

    // Create a fenced code element
    var fencedCodeSpan = mdf.FencedCodeBlock(startToken, null, endToken);

    // Create text content for the fenced code element
    fencedCodeSpan.AppendChild(mdf.Text("Source code text"));

    //Add the fenced code element to MD file
    markdown.AppendChild(fencedCodeSpan);
            
    // Prepare a path for MD file saving 
    string savePath = Path.Combine(OutputDir, "markdown-code-block.md");

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