Praca z funkcjami Markdown

W tym temacie omówiono sposób implementowania funkcji Markdown przy użyciu formatu Aspose.Words. Markdown to prosty sposób formatowania zwykłego tekstu, który można łatwo przekonwertować na format HTML. Aspose.Words obsługuje następujące funkcje Markdown:

• Nagłówki
• Cytaty blokowe
• Zasady horyzontalne
• Odważne podkreślenie
• Podkreślenie kursywą

Implementacja funkcji Markdown jest w większości zgodna ze specyfikacją CommonMark w formacie Aspose.Words API, a wszystkie funkcje są reprezentowane jako odpowiadające im style lub formatowanie bezpośrednie. Co oznacza że

• Pogrubienie i kursywa są reprezentowane jako Font.Bold i Font.Italic
• Nagłówki to akapity ze stylami Nagłówek 1 - Nagłówek 6
• Cytaty to akapity zawierające słowo “Cytat” w nazwie stylu
• HorizontalRule to akapit o kształcie HorizontalRule.

Istnieją niuanse tłumaczenia Markdown na Aspose.Words Document Object Model (DOM), opisane w artykule Przetłumacz Markdown na Document Object Model (DOM).

Dokument Markdown z wyróżnieniami

W tej sekcji pokazano, jak utworzyć dokument markdown z wyróżnieniami podanymi poniżej:

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

Poniższy fragment kodu można wykorzystać do utworzenia powyższego dokumentu markdown.

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

Dokument Markdown z nagłówkami

W tej sekcji pokazano, jak utworzyć dokument markdown z nagłówkami podanymi poniżej:

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

Poniższy fragment kodu można wykorzystać do utworzenia powyższego dokumentu markdown.

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

Dokument Markdown z cytatami blokowymi

W tej sekcji pokazano, jak utworzyć dokument markdown z cudzysłowami blokowymi, jak podano poniżej:

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
>

Poniższy fragment kodu można wykorzystać do utworzenia powyższego dokumentu markdown.

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

Dokument Markdown z linią poziomą

W tej sekcji pokazano, jak utworzyć dokument markdown z linią poziomą, jak podano poniżej:

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

Poniższy fragment kodu można wykorzystać do utworzenia powyższego dokumentu markdown.

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

Czytanie dokumentu Markdown

Poniższy fragment kodu pokazuje, jak czytać dokument markdown.

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

Określ opcje zapisywania Markdown

Aspose.Words API udostępnia klasę MarkdownSaveOptions umożliwiającą określenie dodatkowych opcji podczas zapisywania dokumentu w formacie Markdown.

Poniższy przykład kodu zademonstrował, jak określić różne opcje zapisywania Markdown.

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

Jak wyrównać zawartość tabeli podczas eksportowania do formatu Markdown

Aspose.Words API udostępnia wyliczenie TableContentAlignment, które definiuje kierunki wyrównania w celu wyrównania zawartości tabel podczas eksportu do dokumentu Markdown. Poniższy przykład kodu demonstruje, jak wyrównać zawartość wewnątrz tabeli.

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