MkDocs 01 – Costruiamo un sito con MkDocs e Python! Parte 1

Benvenuti alla prima parte di una serie di articoli su come costruire un sito con MkDocs e Python! In questo articolo, vedremo come iniziare a utilizzare MkDocs per creare un sito statico e organizzare la documentazione del nostro progetto.

Cos’è MkDocs?

MkDocs è uno strumento di generazione di siti statici progettato per la creazione di documentazione basata su Markdown. Utilizza Python e un insieme di modelli predefiniti per creare siti web eleganti e facili da navigare a partire da documentazione scritta in formato Markdown.

Come iniziare

Per iniziare, è necessario installare MkDocs sul proprio sistema. MkDocs è disponibile tramite pip, il gestore dei pacchetti Python, quindi l’installazione è molto semplice. Esegui il seguente comando sul tuo terminale:

pip install mkdocs

Una volta installato MkDocs, è possibile creare un nuovo progetto MkDocs utilizzando il seguente comando:

mkdocs new my-project

Dove “my-project” è il nome del tuo progetto. Questo comando creerà una nuova cartella con la struttura di base del progetto MkDocs.

Creare la documentazione

Una volta creato il progetto MkDocs, è possibile compilare la documentazione del proprio progetto utilizzando il formato Markdown. MkDocs supporta una varietà di funzionalità di formattazione di Markdown, come titoli, elenchi, codice e collegamenti ipertestuali, il che lo rende ideale per la scrittura di documentazione.

Compilare il sito

Una volta completata la scrittura della documentazione, è possibile compilare il sito utilizzando il seguente comando:

mkdocs build

Questo comando genererà un sito statico nella cartella “site” del proprio progetto. È ora possibile visualizzare il sito in un browser locale utilizzando il seguente comando:

mkdocs serve

Questo avvierà un server locale e aprirà il sito nel browser predefinito.

Conclusioni

In questa prima parte, abbiamo visto come iniziare con MkDocs e creare un sito statico di base utilizzando la documentazione scritta in Markdown. Nei prossimi articoli, approfondiremo ulteriormente MkDocs e esploreremo le sue funzionalità avanzate.

Se sei interessato a imparare di più su MkDocs, assicurati di tenere d’occhio la prossima parte di questa serie!