Aspose.Words Procesor plików Markdown dla .NET

Aspose.Words Markdown File Processor dla .NET umożliwia programistom tworzenie, ładowanie, edytowanie i przechowywanie dokumentów markdown w sposób programowany przy użyciu tego samego znanego modelu obiektu, jak Aspose..Word.

Instalacja i ustawienie

Przekierowane platformy: Windows, Linux, macOS, system operacyjny mobilny z .NET Framework, .Net Core/5/6+, lub Mono.IDES: Visual Studio 2010–2022, Xamarin, MonoDevelop.

Szybki start: Tworzenie pliku Markdown 

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

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

doc.Save("Output.md");

Charakterystyka i funkcjonalność

Tworzenie dokumentu

  • Generuj nowe .md Dane są dynamiczne.
  • Wprowadź tytuły, ustęgi, listy, tabele i metadane.
  • Ustaw właściwości poziomu dokumentu, takie jak tytuł, autor i etykiety.

dokumenty ładowania

  • Obciążenie istniejące .md pliki z dysku, strumieni lub pasków.
  • Utrzymuje strukturę: tytuły, tabele, listy i formatowanie inline.
  • Utrzymuje bloki kodowe, metadane i linki w stylu odniesienia.

DOM (Document Object Model) – model obiektów dokumentowych)

  • Dostęp i manipulacja:

  • Paragrafy i wyścigi (bold, italic, strikethrough, inline code)

  • głowy (H1 – H6)

  • Listy (przesyłane / bezprzewidziane, niestowane)

  • tablice, szkielety i komórki

  • KodBlock & InlineCode przyciski

  • Links & Images (z tekstem alt, tytułami i adresami URL)

Tekst i formatowanie inline

  • Zastosuj syntax Markdown za pomocą atrybutów Run.
  • Wsparcie odważne (**), w języku włoskim (*), w sposób rygorystyczny (~~), wskaźnik i kod inline (```).
  • Porozmawiaj z formatowaniem przez paragrafy i listy w sposób niezawodny.

Główne i sekcje

  • Programowe dostosowanie poziomu kierunku.
  • Reorganizacja sekcji dla generacji TOC.
  • Podział lub połączenie bloków opartych na nagłówku.

Listy i listy zniszczone

  • Ustawienie zamówienia (1., 2.) a) lub wstrząśnięty (-, *) i listy.
  • Konwertuj fragmenty w elementy listy.
  • Wprowadź, usunąć lub dynamicznie przekształcić typy list.

Tabela

  • Stwórz i manipuluj tabelami Markdown z GitHub.
  • Wprowadź rzędy / kolumny, połączyć komórki i edytować zawartość.
  • Wsparcie dla komórek wielokrotnych z zachowanym formatowaniem.

Zdjęcia i linki

  • Dodaj lub uaktualnij referencje obrazu (![alt](url "title")).
  • Wprowadzenie linków ([text](url "title")).
  • Obsługuje inline i referencyjny syntax linków.

Bloki kodowe

  • Wprowadź bloky kodowe z etykietami językowymi („csharp).
  • Zarządzaj spany kodowe z automatycznym ucieczką.
  • Dostosowanie stylów podłogowych (backticks lub tildes).

Metadata i Front-Matter

  • Czytaj/pisz YAML lub TOML przedni materiał.
  • Utrzymanie metadanych dla generatorów statycznych lokalizacji (Hugo, Jekyll itp.).

oszczędności i eksportu

  • Zachowaj z powrotem .md Z opcjami:

  • Zachowaj przestrzeń i komentarze.

  • Normalizuj indentację i linie końcowe.

  • Strysk lub aktualizacja metadanych za pomocą callbacks.

Zaawansowane przykłady

Wprowadź istniejący markdown 

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

Wprowadź blok kodowy 

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

Najlepsze praktyki

  • Użyj APIs DOM zamiast regex do transformacji.
  • Centralizuj metadane w przednim materiałie dla kompatybilności generatora.
  • Ponowne wykorzystanie obiektów dokumentów do aktualizacji batch.
  • Zmiany łańcuchowe, aby zminimalizować wykorzystanie pamięci.
  • Pre-warm APIs w środowiskach serwera, aby zmniejszyć latencję pierwszego wezwania.
  • Śledź użytkowanie licencji w rurociągach CI/CD.

Typowe zastosowania

  • Automatyzacja generacja Readme.
  • Tworzenie ** artykułów bazowych wiedzy** dynamicznie.
  • Konwertuj strukturowane dane w dokony Markdown.
  • Utrzymanie dużej dokumentacji ustawia się programicznie.
  • Przygotowanie Markdown dla generatorów statycznych lokalizacji.

FAQ

**Jakie funkcje Markdown są obsługiwane?**Tytuły, listy, tabele, obrazy, linki, formatowanie inline, bloky kodowe i front-matter.

**Czy mogę konwertować Markdown do innych formatów?**No i ładuj .md i przechowywać do DOCX, PDF lub HTML za pomocą Aspose.Words.

**Czy przód jest przechowywany?**Tak i tak. YAML i rozdziały przedmiotowe TOML są czytane/pisane.

**Czy obsługuje linky w stylu referencyjnym?**Tak. Wspierane są zarówno linki typu inline, jak i referencyjne.

**Czy jest to bezpieczne?**Tak, tak długo, jak każda strona używa własnej instancji dokumentu.

 Polski