GitHub: pubblicare un sito Web con un file Markdown

La piattaforma per il code hosting GitHub ha modificato di recente, e notevolmente semplificato, la procedura necessaria per la pubblicazione di un sito Web tra le sue GitHub Pages; ora i passaggi richiesti per completare questa operazione sono soltanto tre e partono, come prevedibile, dalla creazione di un nuovo repository o dall'utilizzo di un repository già esistente.

Una volta generato il nuovo repository o avuto a cesso a quello che si desidera utilizzare per il proprio sito Internet, non si deve fare altro che effettuare il commit di un file Markdown tramite l'apposita interfaccia Web based del servizio, esattamente come si farebbe per qualsiasi altro file; l'ultimo passaggio previsto richiede l'attivazione delle "GitHub Pages" attraverso le impostazioni del proprio repository. Nient'altro!

Sostanzialmente, d'ora in poi tutti i file Markdown verranno automaticamente restituiti sotto forma di GitHub Pages senza la necessità che l'utilizzatore ricorra al formato YAML per ciascun documento; il README viene inoltre utilizzato come index per il sito Web nel caso in cui non sia stato definito un file index.md o index.html. Se non è stato specificato un tema o non è disponibile un file di configurazione viene impostato un tema minimale predefinito.

Nel caso non venga specificato un layout, ne viene assegnato uno sulla base del contesto, per cui le pagine vengono associate ad un page layout o al layout di default quando il primo non è presente. Infine, in mancanza di un titolo, il sistema provvede a rilevare la presenza di Heading tag (H1, H2, H3..) e ad utilizzarli come titoli visualizzabili anche sulle tab dei Web browser.

Tali modifiche non andranno ad alterare i siti Internet precedentemente realizzati, ma per la creazione di nuovi progetti si potrà sfruttare una metodologia pensata per facilitare la pubblicazione di nuovi siti Web, o di documentazioni a corredo del software sviluppato, semplicemente includendo un file Markdown in una cartella "docs" all'interno del repository. Vi sarà in qualsiasi momento la possibilità di personalizzare il sito Web tramite override del tema di default con layout, stili e soluzioni proprie.

Per approfondire: Publishing with GitHub Pages, now as easy as 1, 2, 3