1. Home
  2. Documentation
  3. Sensedia Docs Guia de uso
  4. Guia Completo de Markdown

Guia Completo de Markdown

Domine a sintaxe Markdown com este guia abrangente, incluindo exemplos, boas práticas e recursos avançados.

Markdown torna a formatação de texto simples e portátil

📋 Índice

  1. Introdução
  2. Sintaxe Básica
  3. Recursos Estendidos
  4. Uso Avançado
  5. Boas Práticas
  6. Recursos

Introdução

Markdown é uma linguagem de marcação leve que permite formatar textos com uma sintaxe simples. Criada em 2004 por John Gruber, é amplamente utilizada para:

  • Documentação
  • Arquivos Readme
  • Postagens em blogs
  • Discussões em fóruns
  • Anotações

Principais Benefícios: ✅ Fácil de aprender
✅ Portável entre plataformas
✅ Legível mesmo como texto simples
✅ Suporta HTML quando necessário

Sintaxe Básica

Títulos

Formatação de Texto

Itálico ou Itálico
Negrito ou Negrito
Negrito & Itálico
Tachado
==Destacado==
Código em linha

Listas

Não Ordenada

  • Item 1
    • Subitem 1
      • Sub-subitem 1

Ordenada

  1. Primeiro item
  2. Segundo item
    1. Item aninhado

Mista

  • Item A
  1. Item B
  • Item C

Lista de Tarefas

  • Tarefa concluída
  • Tarefa pendente

Ir para Introdução Ir para Recursos Ir para outra página

Use caminhos relativos para links internos e garanta portabilidade. Por exemplo, [Texto do Link](docs/other-page.md) irá direcionar para other-page.md no diretório docs. Links internos também exibem uma dica com o título e descrição da página de destino.

Entre Documentos

Exemplo de Vídeo Original

Vídeo do YouTube como imagem com link:

Originalmente vídeos não são suportados em Markdown, mas você pode linká-los usando imagens ou incorporar HTML.

Imagens

Sintaxe básica de imagem:

Rollsafe Meme

Com opções de formatação:

Rollsafe Meme

Citações

Esta é uma citação Que abrange várias linhas

Linhas Horizontais


🚀 Recursos Estendidos

Tabelas

Sintaxe
Descrição
CabeçalhoTítulo
ParágrafoTexto

Blocos de Código

Em Linha

Use console.log() para depuração

Realce de Sintaxe

Notas de Rodapé

Aqui está uma referência de nota de rodapé1

Uso Avançado

Diagramas Mermaid

Integração com HTML

Este é um HTML no Markdown

Emojis

:foguete: :brilho: :livros:

Boas Práticas

  1. Consistência Importa

    • Use um único estilo para títulos, listas, etc.
  2. Priorize a Legibilidade

    • Mantenha linhas com menos de 80 caracteres
    • Use linhas em branco entre seções
  3. Acessibilidade

    • Sempre utilize texto alternativo descritivo para imagens
    • Use textos de link significativos
  4. Estrutura do Documento

Recursos

Boa escrita! ✍️

Footnotes

  1. Este é o conteúdo da nota de rodapé

Quão satisfeito você está com esta página?

Nosso site utiliza cookies para habilitar funcionalidades essenciais de avaliação e notificações. Não utilizamos cookies de rastreamento para publicidade ou análise de terceiros.Saiba mais