Uso de cabeçalhos H1 vs. H2 no composer

ao usar um cabeçalho markdown de primeiro nível (#) em um tópico, isso resultará em h1 ou h2 na saída HTML?

Ele irá gerar um <h1> :slight_smile:

então isso significa que o Discourse assume que é bom ter múltiplas tags <h1> em uma página? Parece que se o título do tópico for h1, os cabeçalhos de primeiro nível dentro desse tópico deveriam ser h2 por padrão, não?

O Discourse não assume nada, ele irá gerar o que você pedir para ele gerar.
É uma prática melhor usar ## como títulos de nível superior dentro de uma postagem, com certeza :slight_smile:

1 curtida

Isso é definitivamente uma “educação do usuário” da qual acho que poderíamos nos poupar ao não fazer com que # seja um título de nível 1… :anxious_face_with_sweat:

Você sabe se há alguma maneira de mudar isso? Ou pelo menos ocultar os títulos de nível 1 na barra de ferramentas? (Eu suponho que pessoas que escrevem diretamente em Markdown são um alvo de educação realista…)

1 curtida

Sim, é bem simples. O elemento de lista tem um atributo data-name="heading-1" que você pode selecionar com CSS :slight_smile:

Heh - eu estava vendo isso também. Em um teste rápido, isso oculta a opção H1 tanto no editor de markdown quanto no editor de texto rico:

button[data-name="heading-1"] {
  display: none;
}

(Eu posso manter isso! Não vejo muita razão para oferecer H1 no editor.)

2 curtidas

Eu entendo seu ponto, mas isso não é algo que o Discourse necessariamente decidiu de uma forma ou de outra. O Discourse segue uma convenção de markdown chamada CommonMark, e ela especifica que # deve ser convertido em um H1. Eu acho que essa convenção de como os cabeçalhos de markdown são convertidos em tags HTML é bem padrão em especificações de markdown importantes.

1 curtida

Bem, dois cabeçalhos <h1> não são uma pergunta tão grande na verdade. É um meme de SEO muito antigo, que não é um problema há muito tempo. O Google e outros usarão o primeiro ou o que considerarem mais adequado.

Podemos discutir se dois cabeçalhos principais são a jogada mais inteligente em termos de conteúdo, mas quando uma plataforma usará um estilo diferente para o nome do tópico e os cabeçalhos nas postagens, isso realmente não importa.

Ainda assim, é mais adequado usar ##/<h2> nas postagens. Mas como isso não desempenha nenhum papel real, minha opinião é que é melhor que os usuários usem alguns cabeçalhos que evitem esses porque estão com medo de usar os cabeçalhos “errados” :man_shrugging:

1 curtida

Os títulos podem ser apenas um pequeno sinal para SEO hoje – mas eu ainda não gosto de múltiplos H1s porque sou um nerd. :nerd_face:

Também estou pensando em como a Steph está criando documentação imprimível para Publicação de Páginas, onde os H1s na postagem estão sendo renderizados ainda maiores que o H1 superior da página:

imagem

Torná-los H2 os manteria um pouco menores que o H1 superior:

imagem

1 curtida

Sim, esse é o problema. Para mim é natural usar primeiro o cabeçalho de primeiro nível, mas se o tema não for estilizado com a mesma suposição, fica confuso. Há uma espécie de desconexão aqui.

(Nota lateral: está mostrando a doc para você em inglês sem nenhuma intervenção da sua parte?!?)

Isso é natural, sim, e faz sentido quando você está construindo uma página da web do zero. Mas um CMS ou sistema de publicação quase sempre obtém o H1 da página de um campo de título, então você normalmente usaria o H2 para as seções de conteúdo.

(E eu usei a ferramenta de tradução do navegador da web para obter o inglês.)