Aspose.Words Elaboratore di file Markdown per .NET

Le Aspose.Words Markdown File Processor pour .NET permet aux développeurs de créer, charger, éditer et sauvegarder des documents de markdown de manière programmatique en utilisant le même modèle d’objet connu comme Aspose-Word. Il est conçu pour la génération dynamique de contenu, l’automatisation de la documentation et les flux de travail de transformation dans lesquels Markingdown est le format préféré.

Installation et configuration

  • Installez le paquet NuGet Aspose.Words.
  • Veuillez appliquer votre licence ( Licenza a consumo ).
  • Ajoutez le Aspose.Words Nom de votre projet.
  • Pour les objectifs de cadre et la configuration du paquet, voir le Guide d’installation .

Platformes soutenues: Windows, Linux, macOS, OS mobile avec .NET Framework, .NET Core/5/6+, ou Mono.IDEs: Visual Studio 2010–2022, Xamarin, MonoDevelop.

Démarrage rapide : Créer un fichier Markdown 

var doc = new Document();
var builder = new DocumentBuilder(doc);

// Insert a horizontal rule (renders as '-----' in Markdown)
builder.InsertHorizontalRule();

doc.Save("Output.md");

Caractéristiques et fonctionnalités

Création de document

  • générer un nouveau .md Fichiers dynamiques.
  • Entrez des titres, des paragraphes, les listes et les métadonnées.
  • Configurez des propriétés de niveau de document telles que le titre, l’auteur et les tags.

Documents chargés

  • La charge existante .md fichiers provenant de disques, de courants ou de filets.
  • Il conserve la structure : titres, tables, listes et formatage en ligne.
  • Il maintient les blocs de code, les métadonnées et les liens de style de référence.

DOM (Document Object Modèle)

  • Accès et manipulation:

  • Paragraphs & Runs (bold, italic, strikethrough, code en ligne)

  • Télécharger les têtes (H1 à H6)

  • Listes (commandées / non commandées, nés)

  • Des tables, des roues et des cellules

  • CodeBlock et InlineCode

  • Links & Images (avec alt texte, titres et URL)

Textes et formats en ligne

  • Appliquer la syntaxe Markdown via les attributs de fonctionnement.
  • Il est courageux (**), En Italie (*), et très strictement (~~), et le code inline (```).
  • Traite le formatage à travers les paragraphes et les listes de manière fiable.

Sections et sections

  • Adaptation programmée des niveaux de direction.
  • Réorganiser les sections pour la génération de TOC.
  • Diviser ou fusionner des blocs basés sur le titre.

Les listes et les listas Nested

  • Il s’agit d’une commande (1., 2.) ou à l’absence (-, *) Les listes.
  • Convertir les paragraphes en éléments de liste.
  • Insérer, supprimer ou transformer les types de liste de manière dynamique.

Les tables

  • Créer et manipuler les tables Markdown GitHub.
  • Insérer les lignes / colonnes, fusionner les cellules et éditer le contenu.
  • Soutien aux cellules multi-linées avec formatage préservé.

Images et liens

  • Ajouter ou mettre à jour des références d’image (![alt](url "title")).
  • Lancement des hyperliens ([text](url "title")).
  • Soutient la syntaxe de liens inline et de style de référence.

Les blocs de code

  • Insérez des blocs de code avec des tags linguistiques (« csharp).
  • Gérer les spans de code en ligne avec l’échappement automatique.
  • personnaliser les styles de fence (backticks ou tildes).

Métadonnées et Front-Matter

  • Lire/écrire YAML ou TOML front-matter.
  • Maintenir les métadonnées pour les générateurs de site statiques (Hugo, Jekyll, etc.).

Économie et exportation

  • Réservez à .md Avec les options:

  • Réservez le blanc et les commentaires.

  • Normaliser l’indentation et les finitions de ligne.

  • Télécharger ou mettre à jour les métadonnées avec des appels.

Exemples avancés

Création d’un Markdown existant 

var doc = new Document("Quotes.md");
var builder = new DocumentBuilder(doc);

builder.MoveToDocumentEnd();
builder.ParagraphFormat.ClearFormatting();
builder.Writeln("\n");

// Insert inline code with backticks
var inlineCodeStyle = doc.Styles.Add(StyleType.Character, "InlineCode.3");
builder.Font.Style = inlineCodeStyle;
builder.Writeln("Produced by Aspose.Words Markdown Processor.");

doc.Save("UpdatedQuotes.md");

Insérer le bloc de code 

var builder = new DocumentBuilder(new Document());
builder.Writeln("```csharp");
builder.Writeln("Console.WriteLine(\"Hello Markdown\");");
builder.Writeln("```");

Migliori pratiche

  • Utilisez les APIs DOM au lieu de regex pour les transformations.
  • Centralisez les métadonnées dans le matériau avant pour la compatibilité du générateur.
  • Réutiliser les objets de document pour les mises à jour de batch.
  • Modifications de chaîne pour minimiser l’utilisation de la mémoire.
  • APIs préchauffés dans les environnements du serveur pour réduire la latence de la première appel.
  • Suivez l’utilisation de la licence dans les pipelines CI/CD.

Casi d’uso comuni

  • Génération de l’automatisation ** README**.
  • Création Articles de base de connaissances dynamiquement.
  • Convertir les données structurées en Docs de Markdown.
  • Le maintien de la grande documentation s’établit de manière programmatique.
  • Préparation de Markdown pour les générateurs de site statique.

FAQ

**Quelles fonctionnalités Markdown sont soutenues?**Titres, listes, tables, images, liens, formatage en ligne, blocs de code et front-matter.

**Puis-je convertir Markdown dans d’autres formats?**Oui, la charge .md et sauvegarder à DOCX, PDF ou HTML en utilisant Aspose.Words.

**Le front-match est-il conservé?**Oui oui. YAML et les sections front-matérales de TOML sont lues / écrites.

**Soutient-il des liens de style de référence?**Oui, les liens inline et de style de référence sont soutenus.

**Est-ce que c’est un thread-safe?**Oui, tant que chaque fil utilise sa propre instance Document.

 Français