O que é um arquivo LEIA-ME "formatado como markdown" no Github?

27

Não está claro para mim qual é o formato, se houver requisitos sistemáticos / de linha de comando para criá-lo etc.

Basicamente, apenas para conhecer as especificações e se existem etapas técnicas para gerar o arquivo README.

github

— erros
fonte

4

Não, apenas um arquivo de texto que você edita manualmente. Quanto à sintaxe, en.wikipedia.org/wiki/Markdown

— Andrea

3

é o mesmo formato wiki de edição que esse lado usa.

— K3b

+1 @Andrea: Obrigado, embora eu possa pensar em mais de um punhado de formatos de descontos, qual formato e versão é esperado no Github? Além disso, seu comentário é mais uma resposta, publique-a como uma resposta completa. Mais uma vez, obrigado!

— erros cometidos

+1 @ K3b: Acredite em algo, você está falando sobre o uso do Gollum pelo Github , que por exemplo permite links relativos? Em caso afirmativo, poste como resposta, pois acredito que seja a resposta correta. Obrigado!

— erros cometidos

37

Markdown é uma sintaxe simples para fornecer informações semânticas e representar formatação comum em texto sem formatação. O Daring Fireball tem um guia de sintaxe incrível para descontos padrão . O GitHub usa uma variante disso, que eles chamam de Markdown com sabor do GitHub .

Para configurar seu leia-me, basta criar um arquivo de texto sem formatação e nomeá-lo como README (ou README.md / README.markdown) e confirmar com a raiz do seu repositório. O GitHub selecionará isso como o readme do projeto.

— Kim Burgess
fonte

2

Eu também criei um vídeo explicando como usar o Markdown. Você pode encontrá-lo aqui: mikemclin.net/markdown-syntax-language

— Mike McLin

9

Wikipedia - Markdown faz referência à página "GitHub Flavored Markdown - Introdução" ( archv. )

Citação da página:

O GitHub usa o que chamamos de "GitHub Flavored Markdown" (GFM) para mensagens, problemas e comentários. Difere do Markdown (SM) padrão em algumas maneiras significativas e adiciona algumas funcionalidades adicionais.

A página também fornece uma descrição das diferenças para o Markdown padrão.

Também há mais informações sobre como o Markdown é realmente renderizado pelo GitHub:

Se você estiver interessado em como renderizamos os arquivos do Markdown, consulte Redcarpet , nossa interface do Ruby para a biblioteca do Sundown .

(Aparentemente, Sundown é o analisador de Markdown real usado por trás das cortinas.)

Para adicionar mais uma camada de abstração, o Sundown é uma bifurcação de outro analisador do Markdown :-)
Cite a página do Sundown no GitHub :

Sundown é um analisador Markdown baseado no código original da biblioteca Upskirt de Natacha Porté.

— Christian Specht
fonte

1

É muito estranho, mas parece que o GitHub não usa o GitMub-Flavored Markdown (GFM) ao renderizar um arquivo README.

O GitHub usa o "GitHub Flavored Markdown" ou GFM em todo o site - em questões, comentários e solicitações pull.

Em vez disso, parece usar uma versão chamada redcarpet como parte do projeto de marcação do GitHub . Eles também suportam vários outros formatos de marcação, incluindo o MediaWiki. Basta usar a extensão de arquivo correta e o GitHub renderizará a marcação.

Se você quiser ver as diferenças entre os dois tipos diferentes de Markdown, leia a descrição do GFM e seus recursos extras .

— Don Kirkby
fonte

1

redcarpet e Github Flavored Markdown são dois conceitos separados, mas complementares, que não são implementações concorrentes da mesma coisa. O redcarpet é basicamente um compilador que pega as coisas escritas na linguagem Github Flavored Markdown e gera HTML ou XHTML.

— 8bittree