Material for MkDocs: come ho costruito la documentazione dei miei corsi QGIS

Buongiorno a tutt@,

Subito dopo aver superato il parere di questa comunità sulla mia candidatura al Programma di certificazione QGIS (luglio 2026), ho subito pensato di condividere con tutti un esempio degli strumenti che utilizzo quando preparo un corso in presenza (o da remoto).

Il repository [1] è già pubblico da luglio 2026, ma ora lo divulgo pubblicamente anche in questa comunità.

È solo un esempio, non è completo né come programma né come esercitazioni, voglio solo condividere la tecnologia open source che utilizzo Material for MkDocs

Material for MkDocs è un potente framework di documentazione basato su MkDocs, un generatore di siti statici per la documentazione di progetto.

È facile da usare, basta solo conosce il markdown( è un linguaggio di marcatura leggero che permette di formattare il testo usando caratteri semplici come asterischi e cancelletti anziché comandi complessi.) non occorre essere developer.

Ecco alcuni esempi di funzionalità per chi non conosce MkDocs:

  • Tema grafico moderno (Material) con modalità chiara/scura
  • Menu di navigazione a schede in alto e indice laterale dei capitoli
  • Barra di ricerca nei contenuti del sito
  • Box colorati per note, avvisi e suggerimenti (admonition)
  • Blocchi di codice con evidenziazione colori e pulsante “copia”
  • Contenuti a schede/tab cliccabili (es. per mostrare varianti)
  • Sezioni “a scomparsa” che si aprono/chiudono
  • Galleria immagini con zoom cliccando sulle foto (lightbox)
  • Formule matematiche ben formattate (per le espressioni QGIS)
  • Diagrammi (schemi/flussi disegnati automaticamente)
  • Tabelle e note a piè di pagina
  • Link “modifica questa pagina” per suggerire correzioni
  • Icone social (YouTube, Telegram, GitHub, ecc.) nel footer

il mio repo è qui [1]:

e per visualizzarlo meglio, qui il sito statico:

rimango a disposizione per chi volesse approfondire.

saluti

1 Like

grazie mille Totò, molto utile perché è raro trovare documentazione su come creare la documentazione :grinning_face:.

per me è fondamentale avere un metodo di documentazione sia delle fasi di un processo sia del processo stesso; il problema è che non ce l’ho :grinning_face:!

lo studio con attenzione e mi prenoto un paio di issue di chiarimenti: me lo sento che non riuscirò a capire tutto.

grazie ancora

s.

Grazie Totò, io ho sempre usato sphinx ma sempre con grandi difficoltà a personalizzare i layout.
C’è modo di mettere la Table of Contents a lato stile read the docs?

Ciao Amedeo,

usare il tema Material for MkDocs è molto facile e se utilizzi la AI riesci a fare un sito statico in pochissimi minuti.

Sì, guarda lo screenshot: e puoi facilmente attivarli o disattivarli dal file di configurazione

saluti