Guia de Markdown
Referência completa para escrever e formatar documentos no TypDocs.
Fundamentos do Markdown
Escreva seu conteúdo usando a sintaxe Markdown padrão. Todos os elementos comuns são suportados nativamente.
- Títulos — use # até ######
- Listas — use - ou 1. para listas ordenadas
- Negrito — envolva o texto com **dois asteriscos**
- Itálico — envolva o texto com *um asterisco*
- Código inline — envolva com `backticks`
- Blocos de código — use três backticks com linguagem opcional
- Tabelas — use | pipes | para separar colunas |
- Links — [texto do link](https://url)
Placeholders Dinâmicos
Use estes placeholders em cabeçalhos, rodapés e no corpo do documento — eles são substituídos automaticamente na renderização:
{title}Substituído pelo primeiro H1 do seu documento{date}Substituído pela data atual{page}Substituído pelo número da página atual{pages}Substituído pelo total de páginasQuebras de Página
Insira uma quebra de página em qualquer lugar do documento adicionando o seguinte comentário HTML em uma linha separada:
Cada seção separada por este comentário começará em uma nova página ao exportar.
Exportando como PDF
Clique no botão Exportar PDF na barra superior para abrir o diálogo de impressão do navegador. Selecione Salvar como PDF para baixar o arquivo. Para melhores resultados, desative cabeçalhos e rodapés no diálogo de impressão — o TypDocs gerencia isso para você.