2013-08-02 6 views
7

Questo è stato un mistero per me per un po ', e per qualche motivo Google non mi ha aiutato, quindi lasciatemelo chiedere.Dov'è GitHub Flavored Markdown (GFM) effettivamente utilizzato in GitHub?

MODIFICA: ok, ho capito che GFM è ovunque in GitHub e perché la modifica della linea in stile GFM non è disponibile ?? È spento? e conosco la regola MD originale. Quello che mi piacerebbe confermare qui è la regola di interruzione di riga GFM. Grazie.

Mi piace molto la GFM soprattutto per il modo in cui la linea di rottura è semplice. https://help.github.com/articles/github-flavored-markdown Tuttavia, non sono mai stato in grado di pubblicare il mio Markdown con questa modalità di becco della linea.

Ad esempio, ho copiato un elenco di sintassi MD in una nuova pagina di uno dei miei wiki su GitHub.

https://github.com/kenokabe/kenokabe.github.io/wiki/MarkDownGFM

Come si può confermare l'origine MD.

This is intended as a quick reference and showcase. 
For more complete info, see [John Gruber's original spec] 

viene applicata una singola riga; tuttavia, il risultato mostrato senza nuova riga.

Cosa mi manca? Dove viene utilizzato GitHub Flavored Markdown (GFM) in GitHub?

(Nota tecnica: Markdown Qui utilizza interruzioni di riga GFM, quindi non c'è alcuna necessità di utilizzare le interruzioni di riga due spazi di MD.)

Certamente dice così, ma ho trovato questo DM utilizza 2 spazi br maniera .

+0

È possibile modificare il titolo della domanda in modo che rifletta il suo nuovo contenuto. –

risposta

10

Contrariamente alle altre risposte, GFM è solo utilizzato in cui il testo è solo entrato attraverso il sito web GitHub, non in README.md e non su GitHub Wiki.

Da https://help.github.com/articles/github-flavored-markdown (il corsivo è mio)

GitHub utilizza quello che stiamo chiamando "GitHub aromatizzata Markdown" (GFM) per messaggi, problemi e commenti.

Il ragionamento dietro questo è che README.md e wiki sono parte del repository Git, e quindi possono essere clonati al di fuori del sito, dove ci si aspetta ragionevolmente (standard) Markdown invece di GFM.

Per maggiori informazioni sulla logica di GitHub, vedere https://github.com/github/markup/issues/208#issuecomment-24927799

Edit:

evidenziazione della sintassi (Pygments) è separato dal GFM, in quanto, GFM impiega evidenziazione della sintassi, tuttavia la presenza di evidenziazione della sintassi non lo fa implica GFM, quindi perché GitHub Pages utilizzerà le interruzioni di riga standard di Markdown: utilizza Pygments, ma non GFM.

+0

Grazie. Questo è quello che pensavo e volevo confermare. In effetti, avevo programmato di creare una pagina come https://github.com/substack/stream-handbook per l'output per conto mio, ma ho trovato difficile modificare con un'interruzione di riga non GFM, quindi. Finisco con lo sviluppo del mio sistema di gestione dei contenuti. –

0

Viene utilizzato quando si visualizza il file README.md nella prima pagina del repository, for example. Inoltre, quando aggiungi commenti è GFM.

+1

Viene anche utilizzato per 'Github Pages' e può essere interpretato con' Jekyll' e tradotto in html. MODO più bello di scrivere direttamente in HTML, IMO. – Houdini

+1

@Houdini, sì, quasi ovunque sul sito, giusto? –

+0

https://github.com/kenokabe/heroku-buildpack-nodejs/blob/master/README.md Questo è parte del mio README.md e ho appena provato Hello/nWorld all'inizio. Nessuna interruzione di linea, vedo. Cosa mi manca ?? –

0

github Markdown aromatizzato viene utilizzato su:

  • file readme del repo
  • qualsiasi file .MD nel vostro repo
  • questioni
  • wiki & pagine

e minimamente su commenti (commit, richieste pull, ecc.)

una nota sui problemi: sembra che usi una versione limitata di GFM piuttosto che su pagine wiki o file readme.

+0

Grazie @xero, hai idea del motivo per cui lo stile di interruzione di linea specifico GFM non viene applicato a loro? –

+1

np. no, non sono proprio sicuro. per i commenti presumo che sia per gli stessi motivi per cui non consentono commenti multi-linea qui. va bene nel contesto della risposta, ma non nel contesto del commento. – xero