Aspose.Words Elaboratore di file Markdown per .NET

Il **Aspose.Words Markdown File Processor per .NET ** consente agli sviluppatori di creare, caricare, modificare e salvare i documenti di taglio in modo programmatico utilizzando lo stesso modello di oggetto familiare come Aspose..Word. È progettato per la generazione dinamica di contenuti, l’automazione della documentazione e i flussi di lavoro di trasformazione in cui il formato preferito è il tagliare.

Installazione e Setup

  • Installare il pacchetto NuGet Aspose.Words.
  • Applicare la tua licenza ( Licenza a consumo ).
  • Aggiungi il Aspose.Words Nome per il tuo progetto.
  • Per gli obiettivi quadro e la configurazione del pacchetto, vedere il Guida di installazione .

Piattaforme supportate: Windows, Linux, macOS, OS mobile con .NET Framework, .Net Core/5/6+, o Mono.IDE: Visual Studio 2010-2022, Xamarin e MonoDevelop.

Inizio rapido: Creare un file Markdown

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

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

doc.Save("Output.md");

Caratteristiche e funzionalità

Creazione di documenti

  • Generare Nuovo .md Il file è dinamico.
  • Inserisci titoli, paragrafi, elenchi, tabelle e metadati.
  • Imposta le proprietà a livello di documento come titolo, autore e etichette.

Il caricamento dei documenti

  • Carico esistente .md file dal disco, dai flussi o dalle strisce.
  • Conserva la struttura: titoli, tabelle, elenchi e formattazione in linea.
  • Mantenere i blocchi di codice, i metadati e i collegamenti in stile di riferimento.

DOM (Document Object Model) – Modello di oggetto documentale)

  • L’accesso e la manipolazione:

  • Paragrafs & Runs (bold, italiano, rigido, codice in linea)

  • Capelli (H1 - H6)

  • Liste (in ordine / non ordinato, nuvolato)

  • Tabelle, rami e cellule

  • CodeBlock e Node Inline

  • Links & Images (con alt testo, titoli e URL)

Il testo e la formattazione in linea

  • Applicare la sintesi Markdown tramite attributi di esecuzione.
  • Il sostegno del coraggio (**), La lingua italiana (*), e in modo rigido (~~), e il codice inline (```).
  • Mantenere la formattazione attraverso paragrafi e elenchi in modo affidabile.

Sede e sezioni

  • Programmaticamente adattare i livelli di riferimento.
  • Ristrutturare le sezioni per la generazione TOC.
  • Divisione o fusione di blocchi basati sul titolo.

Elenchi e Nested Lists

  • La costruzione è ordinata (1., 2.) o non è stato rivelato (-, *) e delle liste.
  • Convertire i paragrafi in articoli di lista.
  • Inserire, rimuovere o trasformare i tipi di elenco in modo dinamico.

Tavolo

  • Creare e manipolare le tabelle Markdown flavorate da GitHub.
  • Inserire righe/colonne, fusione delle cellule e modificare il contenuto.
  • Supporto per cellule multiline con formato conservato.

Immagini e link

  • Aggiungere o aggiornare le immagini di riferimento (![alt](url "title")).
  • Inserisci i link ([text](url "title")).
  • Supporta inline e reference-style link syntax.

Codice Blocco

  • Inserisci i blocchi di codice con le etichette linguistiche (‘csharp).
  • Gestione delle spalle di codice inline con auto-escaping.
  • Personalizzare gli stili di forno (backticks o tildes).

Metadati e Front-Matter

  • Leggi/scrivi YAML o TOML front-matter.
  • Mantenere i metadati per i generatori di sito statico (Hugo, Jekyll, ecc.).

Risparmio e esportazione

  • Risparmiamo di nuovo .md con le opzioni:

  • Conservare spazio e commenti.

  • Normalizza l’indentazione e i fini della linea.

  • Strip o aggiornare i metadati con callbacks.

Esempi avanzati

Edito di Markdown esistente

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

Inserisci il codice blocco

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

Migliori pratiche

  • Utilizzare API DOM invece di regex per le trasformazioni.
  • Centralizzare i metadati in front-matter per la compatibilità del generatore.
  • Ripristinare gli oggetti di documento per aggiornamenti di batch.
  • Modifiche di catena per ridurre al minimo l’utilizzo della memoria.
  • Pre-calore API in ambienti server per ridurre la latenza di prima chiamata.
  • Seguire l’uso delle licenze nei tubi CI/CD.

Casi d’uso comuni

  • Automatizzazione Generazione Readme.
  • Costruire ** articoli di base della conoscenza** in modo dinamico.
  • Convertire i dati strutturati in Docs Markdown.
  • La manutenzione di grandi documentazioni si impone in modo programmatico.
  • Preparazione di Markdown per generatori di sito statico.

FAQ

**Quali funzionalità Markdown sono supportate?**Titoli, elenchi, tabelle, immagini, collegamenti, formattazione in linea, blocchi di codice e front-matter.

**Posso convertire Markdown in altri formati?**Sì, carica .md e salvare in DOCX, PDF, o HTML utilizzando Aspose.Words.

**Il front-matter è conservato?**Sì sì. Il YAML e le sezioni front-matter di TOML sono lette/scritte.

**Supporta i collegamenti di stile di riferimento?**Sì, sono supportati entrambi i collegamenti inline e in stile di riferimento.

**Si tratta di thread-safe?**Sì, finché ogni thread utilizza la propria instanza Document.

 Italiano