MkDocs
MkDocs è uno strumento sviluppato in Python per generare siti di documentazione statica basati su file Markdown.
Panoramica
MkDocs è uno strumento molto popolare con una vasta comunità. Ha diversi temi per la creazione di siti web; diversi plugins per estendere le funzionalità di base del programma e una documentazione di facile comprensione.
MkDocs è un progetto open source sviluppato in Python.
L'applicazione utilizza il processore Markdown Python-Markdown che fornisce un ottimo supporto per elementi di sintassi di base, tuttavia, la compatibilità con gli elementi di sintassi estesa lascia un po 'a desiderare.
Vale la pena notare che, poiché MkDocs utilizza Python-Markdown, è possibile attivare estensioni aggiuntive per modificare il comportamento del parser, fare clic qui per visualizzare un elenco di estensioni disponibili compatibili con Python-Markdown.
Puoi trovare maggiori informazioni sul sito ufficiale di MkDocs https://www.mkdocs.org/.
Utilizzo di Admonitions in MkDocs
L'estensione Admonitions ti consente di mostrare agli utenti messaggi stilizzati sulla tua pagina su siti web creati con MkDocs.
Per ulteriori informazioni ed esempi, vedere quella pagina su GitHub.
Supporto per Markdown in MkDocs
La Tabella 1.1 presenta gli elementi Markdown compatibili con MkDocs.
| Elemento | Supporto | Informazione |
|---|---|---|
| Titoli | Sì | |
| Paragrafi | Sì | |
| Interruzioni di riga | Sì | |
| Grassetto | Sì | |
| Corsivo | Sì | |
| Blockquote | Sì | |
| Elenchi ordinati | Sì | |
| Elenchi non ordinati | Sì | |
| Codice | Sì | |
| Linee orizzontali | Sì | |
| Links | Sì | |
| immagini | Sì | |
| Tabelle | Sì | |
| Blocchi di codice recintati | Sì | È possibile evidenziare la sintassi del contenuto del blocco. |
| Note a piè di pagina | No | |
| ID titolo | No | |
| Elenchi di definizioni | No | |
| Barrato | No | |
| Elenchi di attività | No | |
| Emoji (copia e incolla) | Sì | Non è supportato per impostazione predefinita, ma è possibile abilitare un'estensione per utilizzare questo elemento Markdown. |
| Emoji (codici di accesso) | Sì | MkDocs non supporta i codici emoticons per impostazione predefinita, ma è possibile installare un'estensione per formattare il contenuto utilizzando questo elemento Markdown. |
| automatico URL Link | Sì | |
| Disabilita URL link automatico | Sì | |
| HTML | Sì |