Mkdocs tutorial
Introduzione¶
In questa serie di due incontri vi presentiamo MkDocs.
MkDocs è un generatore di siti web statici, progettato principalmente per la creazione di documentazione utilizzando file Markdown. Markdown è un linguaggio di markup leggibile che consente di formattare il testo in modo semplice utilizzando una sintassi semplice e intuitiva.
MkDocs semplifica notevolmente il processo di creazione e gestione della documentazione, consentendo agli utenti di concentrarsi sul contenuto senza doversi preoccupare della complessità della creazione di pagine HTML o della gestione dei layout. Utilizzando MkDocs, è possibile organizzare la documentazione in una struttura di cartelle e file Markdown, che verranno quindi convertiti automaticamente in pagine HTML pronte per la pubblicazione.
Questo sito é stato costruito interamente con mkdocs e il tema mkdocs material. L'hosting del sito e il deploy é stato reso possibile grazie a github pages e github actions.
Struttura del percorso¶
- Elementi principali di mkdocs
- Extra, plugin e deploy del sito
Materiale¶
