Markdown Parser (Arquivado)

Advertência

Este componente foi arquivado e não está disponível na versão atual do Windows Community Toolkit.

  • O novo MarkdownTextBlock controlo no Windows Community Toolkit Labs utiliza o Markdig internamente, não este MarkdownParser.
  • Para necessidades de análise personalizada, considere usar o Markdig diretamente na sua aplicação.

Para mais informações:

A documentação original segue-se abaixo.

Advertência

(Esta API será removida no futuro. Por favor, considere usar o Markdig para análise de documentos Markdown.

A classe MarkdownDocument permite-te analisar uma String Markdown num Documento Markdown e depois renderizá-la com um Renderizador Markdown.

Experimenta na aplicação de exemplo

Example

string md = "This is **Markdown**";
MarkdownDocument document = new MarkdownDocument();
document.Parse(md);

// Takes note of all of the Top Level Headers.
foreach (var element in document.Blocks)
{
    if (element is HeaderBlock header)
    {
        Console.WriteLine($"Header: {header.ToString()}");
    }
}

Dim md As String = "This is **Markdown**"
Dim document As MarkdownDocument = New MarkdownDocument()
document.Parse(md)

For Each element In document.Blocks
    If TypeOf element Is HeaderBlock Then
        Console.WriteLine($"Header: {element.ToString()}")
    End If
Next
End Sub

Aulas

Class Propósito
Microsoft.Toolkit.Parsers.Markdown.MarkdownDocument Representa um Documento de Markdown.
Microsoft.Toolkit.Parsers.Markdown.Render.MarkdownRendererBase Um renderizador base para converter Markdown em Controles.

Documento Markdown

Propriedades

Propriedade Tipo Description
Blocos IList<MarkdownBlock> Obtém ou define a lista de elementos do bloco.

Methods

Methods Tipo de Retorno Description
Análise (corda) Vazio Analisa o texto do documento de markdown.
LookUpReference(string) LinkReferenceBlock Procura uma referência usando o identificador.

Criar um Renderizador Markdown

Para criar um Markdown Renderer, podes implementar o teu próprio, ou herdar de MarkdownRendererBase, esta classe já tem todos os métodos necessários e algum código assistivo para facilitar a implementação de um Renderizador, tudo o que tens de fazer é implementar o Block and Inline Rendering, e o resultado.

Isto requer uma propriedade herdada IRenderContext, que permite acompanhar o Contexto da renderização.

A melhor forma de perceber como criar um Renderizador é olhar para a implementação do controlo UWP MarkdownTextBlock.

Projeto de Exemplo

Fonte da Página de Exemplo do Markdown Parser. Pode ver isto em ação na aplicação de exemplo do Windows Community Toolkit.

Requerimentos

Implementation .NET Standard 1.4.
Namespace Microsoft.Toolkit.Parsers
Pacote NuGet Microsoft.Toolkit.Parsers

API

  • Last updated on