non è in grado di trovare documentazione dettagliata e specifica per l'utilizzo del markdown sul progetto github e sulle pagine utente

Question

Sono in procinto di aggiungere pagine github ad alcuni dei miei repository e alla mia pagina utente. Per molte pagine Web, desidero utilizzare la formattazione Markdown.

Tuttavia, poiché sono in grado di trovare solo le informazioni su vague, undetailed su come eseguire questa operazione, sto eseguendo tentativi ed errori per capire come funziona.

Dov'è la vera documentazione? I dettagli cruenti?

---

Here è la migliore informazione che ho trovato finora, che dice:

• utilizzare il nome del ramo speciale gh-pages di creare un sito per un progetto repo

• tre-line è necessario l'incantesimo nella parte superiore del file:

  --- 
  title: something 
  --- 
  

• il suffisso viene modificato in .html

Ma io sono lasciato con molte domande su dettagli, come ad esempio:

• è possibile importare file css?
• cosa fa effettivamente quel blurb "titolo"?
• quale suffisso devono avere i file?

ecc. Quindi mi piacerebbe molto vedere la documentazione dettagliata per tutte le funzionalità.

---

prega di notare che questa domanda non è su come utilizzare la sintassi Markdown, ma come sfruttare la magia di GitHub per la creazione automatica HTML Markdown nell'ambito delle pagine utente e di progetto.

Answer 1

come sfruttare la magia di GitHub per la creazione automatica HTML Markdown nell'ambito delle pagine utente e di progetto

Sembra che si sta parlando di Jekyll.

---

Che cosa significa che "titolo" Blurb effettivamente fare?

Il title è parte di YAML Front Matter. Si tratta essenzialmente di una variabile che è possibile access via page.title

---

Cosa suffisso fanno i file devono avere?

A condizione che il file abbia una sezione di Frontespizio YAML, sarà trasformato da Jekyll.Lo stesso accadrà per qualsiasi file .html, .markdown, .md o .textile nella directory principale del tuo sito o nelle directory non elencate sopra.

github.com/mojombo/jekyll/wiki/usage

Answer 2

solo i file con le estensioni .md o .markdown saranno tradotti in HTML su una GitHub utente Page.

I file con estensioni .html e .textile sono non tradotto, secondo i miei tentativi.

Si noti che la codifica UTF8 deve essere evitata.