與 Markdown 功能工作
這篇文章討論如何透過Aspose.Words來實作Markdown功能。Markdown是一種簡單的方式來格式化普通文字,並可以輕易地轉換成HTML。Aspose.Words支援以下Markdown功能:
- 標題
- 引用區块
- 水平方向的線條
- 粗體強調
- 斜體強調
Markdown 功能實作主要依循 CommonMark
規格在 Aspose.Words API 中,所有功能皆以對應的風格或直接格式來表現。 這意味著
-粗體和斜體分別表示為 Font.Bold
和 Font.Italic
。
- 標題是具有標頭1至標頭6風格的段落。 “- 引用是具有引文風格名稱的段落。”
- HorizontalRule 是具有水平線形狀的段落。
Markdown 文本強調
本節示範如何透過以下強調來製作一個 markdown 文檔:
Markdown treats asterisks (*) and underscores (_) as indicators of emphasis.
You can write **bold** or *italic* text.
You can also write ***BoldItalic*** text.
接下來這個程式碼片段可用於產生上面所給的 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"); |
Markdown 文檔有標題
本節示範如何以以下 headings 的形式製作 markdown 文檔:
The following produces headings:
# Heading1
## Heading2
### Heading3
#### Heading4
##### Heading5
###### Heading6
# **Bold Heading1**
以下代碼片段可用於產生上述給定的 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"); |
Markdown 具有塊引用之文件
本節示範如何根據以下範例產生一份具有塊引言的markdown文件:
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
>
以下程式碼片段可用來產生上面給定的 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"); |
Markdown 水平線式文件
本節示範如何建立一個包含水平線條的 markdown 文件:
We support Horizontal rules (Thematic breaks) in Markdown:
-----
下面的程式碼片段可用來產生上面給定的 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); |
閱讀 Markdown 文檔
接下來這個程式碼片段會教你如何讀取一個 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"); |
指定 Markdown 保存選項
Aspose.Words API 在儲存文档到 Markdown 格式時提供 MarkdownSaveOptions 類別來指定其他選項。
接下來的程式碼範例示範了如何指定各種不同的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); |
如何在輸出到 Markdown 的同時,對表格內部的內容進行對齊?
Aspose.Words API 提供 TableContentAlignment 列舉,定義了將資料排印到表格的對齊方向,同時將資料輸出到 Markdown 文檔。 接下來的程式碼範例說明了如何在表格內對齊內容。
// 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); |