Arbeiten mit Markdown-Funktionen

In diesem Thema wird erläutert, wie Markdown-Funktionen mithilfe von Aspose.Words implementiert werden. Markdown ist eine einfache Möglichkeit, einfachen Text zu formatieren, der leicht in HTML konvertiert werden kann. Aspose.Words unterstützt die folgenden Markdown-Funktionen:

• Überschriften
• Block Zitate
• Horizontale Regeln
• Fette Betonung
• Kursive Hervorhebung

Die Markdown-Funktionsimplementierung folgt größtenteils der CommonMark-Spezifikation in Aspose.Words API und alle Funktionen werden als entsprechende Stile oder direkte Formatierung dargestellt. Was bedeutet, dass

• Fett und Kursiv werden als Font.Bold und Font.Italic dargestellt
• Überschriften sind Absätze mit den Stilen Überschrift 1 - Überschrift 6
• Zitate sind Absätze mit “Zitat” im Stilnamen
• HorizontalRule ist ein Absatz mit der Form “HorizontalRule”.

Es gibt Nuancen bei der Übersetzung von Markdown in Aspose.Words Document Object Model (DOM), die im Artikel Übersetzen Sie Markdown in Document Object Model (DOM) beschrieben werden.

Markdown-Dokument mit Schwerpunkten

In diesem Abschnitt erfahren Sie, wie Sie ein markdown-Dokument mit den folgenden Schwerpunkten erstellen:

Markdown treats asterisks (*) and underscores (_) as indicators of emphasis.
You can write **bold** or *italic* text. 
You can also write ***BoldItalic*** text.

Mit dem folgenden Codeausschnitt kann das oben angegebene markdown-Dokument erstellt werden.

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-.NET
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.Writeln("Markdown treats asterisks (*) and underscores (_) as indicators of emphasis.");
builder.Write("You can write ");
builder.Font.Bold = true;
builder.Write("bold");
builder.Font.Bold = false;
builder.Write(" or ");
builder.Font.Italic = true;
builder.Write("italic");
builder.Font.Italic = false;
builder.Writeln(" text. ");
builder.Write("You can also write ");
builder.Font.Bold = true;
builder.Font.Italic = true;
builder.Write("BoldItalic");
builder.Font.Bold = false;
builder.Font.Italic = false;
builder.Write("text.");

builder.Document.Save("EmphasesExample.md");

Markdown-Dokument mit Überschriften

In diesem Abschnitt erfahren Sie, wie Sie ein markdown-Dokument mit den folgenden Überschriften erstellen:

The following produces headings:
# Heading1
## Heading2
### Heading3
#### Heading4
##### Heading5
###### Heading6
# **Bold Heading1**

Mit dem folgenden Codeausschnitt kann das oben angegebene markdown-Dokument erstellt werden.

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-.NET
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// By default Heading styles in Word may have bold and italic formatting.
// If we do not want text to be emphasized, set these properties explicitly to false.
builder.Font.Bold = false;
builder.Font.Italic = false;

builder.Writeln("The following produces headings:");
builder.ParagraphFormat.Style = doc.Styles["Heading 1"];
builder.Writeln("Heading1");
builder.ParagraphFormat.Style = doc.Styles["Heading 2"];
builder.Writeln("Heading2");
builder.ParagraphFormat.Style = doc.Styles["Heading 3"];
builder.Writeln("Heading3");
builder.ParagraphFormat.Style = doc.Styles["Heading 4"];
builder.Writeln("Heading4");
builder.ParagraphFormat.Style = doc.Styles["Heading 5"];
builder.Writeln("Heading5");
builder.ParagraphFormat.Style = doc.Styles["Heading 6"];
builder.Writeln("Heading6");

// Note, emphases are also allowed inside Headings:
builder.Font.Bold = true;
builder.ParagraphFormat.Style = doc.Styles["Heading 1"];
builder.Writeln("Bold Heading1");

doc.Save(dataDir + "HeadingsExample.md");

Markdown-Dokument mit Blockzitaten

In diesem Abschnitt erfahren Sie, wie Sie ein markdown-Dokument mit Anführungszeichen wie unten angegeben erstellen:

We support blockquotes in Markdown:
>*Lorem*
>*ipsum*
>The quotes can be of any level and can be nested:
>>>Quote level 3
>>>
>>>>Nested quote level 4
>
>*Back to first level*
>### Headings are allowed inside Quotes
>

Mit dem folgenden Codeausschnitt kann das oben angegebene markdown-Dokument erstellt werden.

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-.NET
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

builder.Writeln("We support blockquotes in Markdown:");
builder.ParagraphFormat.Style = doc.Styles["Quote"];
builder.Writeln("Lorem");
builder.Writeln("ipsum");
builder.ParagraphFormat.Style = doc.Styles["Normal"];
builder.Writeln("The quotes can be of any level and can be nested:");
Style quoteLevel3 = doc.Styles.Add(StyleType.Paragraph, "Quote2");
builder.ParagraphFormat.Style = quoteLevel3;
builder.Writeln("Quote level 3");
Style quoteLevel4 = doc.Styles.Add(StyleType.Paragraph, "Quote3");
builder.ParagraphFormat.Style = quoteLevel4;
builder.Writeln("Nested quote level 4");
builder.ParagraphFormat.Style = doc.Styles["Quote"];
builder.Writeln();
builder.Writeln("Back to first level");
Style quoteLevel1WithHeading = doc.Styles.Add(StyleType.Paragraph, "Quote Heading 3");
builder.ParagraphFormat.Style = quoteLevel1WithHeading;
builder.Write("Headings are allowed inside Quotes");

doc.Save(dataDir + "QuotesExample.md");

Markdown-Dokument mit horizontaler Regel

In diesem Abschnitt erfahren Sie, wie Sie ein markdown-Dokument mit der horizontalen Regel wie folgt erstellen:

We support Horizontal rules (Thematic breaks) in Markdown:
-----

Mit dem folgenden Codeausschnitt kann das oben angegebene markdown-Dokument erstellt werden.

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-.NET
// Initialize document.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

builder.Writeln("Insert a horizontal rule shape into the document.");
builder.InsertHorizontalRule();

dataDir = dataDir + "DocumentBuilder.InsertHorizontalRule_out.doc";
doc.Save(dataDir);

Ein Markdown-Dokument lesen

Der folgende Codeausschnitt zeigt Ihnen, wie Sie ein markdown-Dokument lesen.

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-.NET
// This is Markdown document that was produced in example of UC3.
Document doc = new Document(dataDir + "QuotesExample.md");

// Let's remove Heading formatting from a Quote in the very last paragraph.
Paragraph paragraph = doc.FirstSection.Body.LastParagraph;
paragraph.ParagraphFormat.Style = doc.Styles["Quote"];

doc.Save(dataDir + "QuotesModifiedExample.md");

Geben Sie Markdown-Speicheroptionen an

Aspose.Words API bietet eine MarkdownSaveOptions-Klasse zur Angabe zusätzlicher Optionen beim Speichern eines Dokuments im Markdown-Format.

Im folgenden Codebeispiel wurde gezeigt, wie verschiedene Markdown-Speicheroptionen angegeben werden.

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-.NET
DocumentBuilder builder = new DocumentBuilder();
builder.Writeln("Some text!");

// specify MarkDownSaveOptions
MarkdownSaveOptions saveOptions = (MarkdownSaveOptions)SaveOptions.CreateSaveOptions(SaveFormat.Markdown);
            
builder.Document.Save(dataDir + "TestDocument.md", saveOptions);

So richten Sie Inhalte innerhalb der Tabelle beim Exportieren in Markdown aus

Aspose.Words API bietet eine TableContentAlignment-Aufzählung, die Ausrichtungsrichtungen definiert, um Inhalte in Tabellen beim Exportieren in das Markdown-Dokument auszurichten. Das folgende Codebeispiel zeigt, wie Inhalte innerhalb der Tabelle ausgerichtet werden.

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-.NET
DocumentBuilder builder = new DocumentBuilder();

// Create a new table with two cells.
builder.InsertCell();
builder.ParagraphFormat.Alignment = ParagraphAlignment.Right;
builder.Write("Cell1");
builder.InsertCell();
builder.ParagraphFormat.Alignment = ParagraphAlignment.Center;
builder.Write("Cell2");

MarkdownSaveOptions saveOptions = new MarkdownSaveOptions();
// Makes all paragraphs inside table to be aligned to Left. 
saveOptions.TableContentAlignment = TableContentAlignment.Left;
builder.Document.Save(dataDir + "left.md", saveOptions);

// Makes all paragraphs inside table to be aligned to Right. 
saveOptions.TableContentAlignment = TableContentAlignment.Right;
builder.Document.Save(dataDir + "right.md", saveOptions);

// Makes all paragraphs inside table to be aligned to Center. 
saveOptions.TableContentAlignment = TableContentAlignment.Center;
builder.Document.Save(dataDir + "center.md", saveOptions);

// Makes all paragraphs inside table to be aligned automatically.
// The alignment in this case will be taken from the first paragraph in corresponding table column.
saveOptions.TableContentAlignment = TableContentAlignment.Auto;
builder.Document.Save(dataDir + "auto.md", saveOptions);