17

Ho usato pagine GitHub per generare un bellissimo sito Web per il mio progetto (this one). Ora voglio mantenere aggiornata la documentazione del mio progetto e avere tutto in un unico file README.md non è probabilmente scalabile alle molte funzionalità che stiamo aggiungendo.Come generare un sito Web dalle pagine wiki di GitHub

Così, ho pensato che il posto migliore per conservare la documentazione è il wiki GitHub, ma mi piacerebbe integrare la wiki al sito generato gh-pages, mantenendo il layout bellissimo.

Come potrei prendere il wiki GitHub e generare un sito Web HTML con un layout personalizzabile?

risposta

6

Ecco un esempio di URL per un wiki:

http://github.com/antirez/redis/wiki

Nella stessa pagina troverete un link clone: ​​

git clone http://github.com/antirez/redis.wiki 

quindi eseguire il file Markdown attraverso Jekyll o addirittura creare un nuovo repository al sito host basato sul Wiki.

+3

Esiste un tutorial da qualche parte per questo? Come si esegue un wiki GitHub tramite Jekyll? – Richard

+1

Documentazione per favore? – BrianTheLion

+0

Ho usato Jekyll e funziona benissimo. Ho sviluppato la mia soluzione per mantenere le cose aggiornate. Grazie per il suggerimento. –

1

È possibile includere il wiki come subtree.

BTW, GitHub Pages ora non ha più bisogno del ramo gh-pages. Creare un repository denominato your-user-name.github.io; genererà automaticamente un sito Web. Vedi GitHub Pages per maggiori dettagli.

+1

C'è una differenza tra una pagina _user_ (usando il metodo '* .github.io') e una pagina _project_ (usando il metodo' gh-pages'), comunque. – heltonbiker