Che cos'è un file README "formattato per il markdown" su Github?

27

Non mi è chiaro quale sia il formato, se ci sono requisiti sistematici / da riga di comando per crearlo, ecc.

Fondamentalmente, solo per conoscere le specifiche e se ci sono passaggi tecnici per generare il file README.

github

— errori
fonte

4

No, solo un file di testo che si modifica a mano. Per quanto riguarda la sintassi, en.wikipedia.org/wiki/Markdown

— Andrea

3

è lo stesso formato di modifica wiki utilizzato da questa parte.

— k3b,

+1 @Andrea: Grazie, anche se sono in grado di pensare a più di una manciata di formati markdown, quale formato e versione sono previsti su Github? Inoltre, il tuo commento si legge come più di una risposta, per favore pubblicalo come risposta completa. Grazie ancora!

— errori del

+1 @ K3b: Credi di avere a che fare con qualcosa, stai parlando dell'uso di Gollum da parte di Github , che ad esempio consente il collegamento relativo? In tal caso, si prega di pubblicare questa come risposta, poiché credo che sia la risposta corretta. Grazie!

— errori del

37

Markdown è una sintassi semplice per fornire informazioni semantiche e rappresentare la formattazione comune in testo semplice. Daring Fireball ha una fantastica guida alla sintassi per il markdown standard . GitHub usa quindi una variante di questo che chiamano GitHub Flavored Markdown .

Per impostare il file Leggimi basta creare un file di testo semplice e denominarlo README (o README.md / README.markdown) e impegnarlo nella radice del repository. GitHub lo prenderà quindi come file readme del progetto.

— Kim Burgess
fonte

2

Ho anche creato un video che spiega come usare Markdown. Puoi trovarlo qui: mikemclin.net/markdown-syntax-language

— Mike McLin

9

Wikipedia - Markdown fa riferimento alla pagina "GitHub Flavored Markdown - Introduzione" ( archv. )

Citazione dalla pagina:

GitHub utilizza ciò che chiamiamo "GitHub Flavored Markdown" (GFM) per messaggi, problemi e commenti. Si differenzia dallo standard Markdown (SM) in alcuni modi significativi e aggiunge alcune funzionalità aggiuntive.

La pagina fornisce anche una descrizione delle differenze rispetto al Markdown standard.

Ci sono anche ulteriori informazioni su come Markdown è effettivamente reso da GitHub:

Se sei interessato a come renderizziamo i file Markdown, potresti provare Redcarpet , la nostra interfaccia Ruby per la libreria Sundown .

(Apparentemente, Sundown è il vero parser Markdown che viene usato dietro le tende.)

Per aggiungere un ulteriore livello di astrazione, Sundown è un fork anche di un altro parser Markdown :-)
Citazione dalla pagina GitHub di Sundown :

Sundown è un parser Markdown basato sul codice originale della libreria Upskirt di Natacha Porté.

— Christian Specht
fonte

1

È molto strano, ma sembra che GitHub non usi GitHub-Flavored Markdown (GFM) durante il rendering di un file README.

GitHub utilizza "GitHub Flavored Markdown" o GFM in tutto il sito, per problemi, commenti e richieste pull.

Invece sembra usare una versione chiamata redcarpet come parte del progetto di markup GitHub . Supportano anche molti altri formati di markup, incluso MediaWiki. Basta usare l'estensione di file corretta e GitHub eseguirà il rendering del markup.

Se vuoi vedere le differenze tra i due diversi gusti di Markdown, leggi la descrizione di GFM e le sue funzionalità extra .

— Don Kirkby
fonte

1

redcarpet e Github Flavored Markdown sono due concetti separati, ma complementari, non implementazioni concorrenti della stessa cosa. redcarpet è fondamentalmente un compilatore che prende le cose scritte nel linguaggio Markdown Flavored di Github e produce HTML o XHTML.

— 8