Trabalhando com recursos Markdown
Este tópico discute como implementar recursos Markdown usando Aspose.Words. Markdown é uma maneira simples de formatar texto simples que pode ser facilmente convertido em HTML. Aspose.Words oferece suporte aos seguintes recursos Markdown:
- Títulos
- Citações em bloco
- Regras horizontais
- Ênfase ousada
- Ênfase em itálico
A implementação do recurso Markdown segue principalmente a especificação CommonMark
em Aspose.Words API e todos os recursos são representados como estilos correspondentes ou formatação direta. O que significa que
- Negrito e Itálico são representados como
Font.Bold
eFont.Italic
- Os títulos são parágrafos com estilos Título 1 - Título 6
- Aspas são parágrafos com “Citação” no nome do estilo
- HorizontalRule é um parágrafo com formato HorizontalRule.
Documento Markdown com ênfases
Esta seção demonstra como produzir um documento markdown com as ênfases fornecidas abaixo:
Markdown treats asterisks (*) and underscores (_) as indicators of emphasis.
You can write **bold** or *italic* text.
You can also write ***BoldItalic*** text.
O trecho de código a seguir pode ser usado para produzir o documento markdown fornecido acima.
// 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"); |
Documento Markdown com títulos
Esta seção demonstra como produzir um documento markdown com os títulos fornecidos abaixo:
The following produces headings:
# Heading1
## Heading2
### Heading3
#### Heading4
##### Heading5
###### Heading6
# **Bold Heading1**
O trecho de código a seguir pode ser usado para produzir o documento markdown fornecido acima.
// 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"); |
Documento Markdown com cotações em bloco
Esta seção demonstra como produzir um documento markdown com aspas em bloco, conforme mostrado abaixo:
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
>
O trecho de código a seguir pode ser usado para produzir o documento markdown fornecido acima.
// 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"); |
Documento Markdown com regra horizontal
Esta seção demonstra como produzir um documento markdown com regra horizontal conforme mostrado abaixo:
We support Horizontal rules (Thematic breaks) in Markdown:
-----
O trecho de código a seguir pode ser usado para produzir o documento markdown fornecido acima.
// 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); |
Lendo um documento Markdown
O trecho de código a seguir mostra como ler um documento 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"); |
Especifique opções de salvamento Markdown
Aspose.Words API fornece classe MarkdownSaveOptions para especificar opções adicionais ao salvar um documento no formato Markdown.
O exemplo de código a seguir demonstrou como especificar várias opções de salvamento 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); |
Como alinhar o conteúdo dentro da tabela ao exportar para Markdown
Aspose.Words API fornece enumeração TableContentAlignment que define direções de alinhamento para alinhar o conteúdo das tabelas durante a exportação para o documento Markdown. O exemplo de código a seguir demonstra como alinhar o conteúdo dentro da tabela.
// 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); |