Formattazione↵
Aggiungere tasti↵
Aggiungere le righe seguenti al file mkdocs.yml
markdown_extensions:
- pymdownx.keys
La combinazione di tasti va circondata da ++ e tra un tasto e un altro un +. Scrivendo ad esempio:
++ctrl+alt+"F1"++
si ottiene:
Ctrl+Alt+F1
Si può usare anche il semplice HTML, come ad esempio:
<kbd>CTRL</kbd>
per ottenere:
CTRL
Qui la documentazione completa.
Apice e pedice↵
Aggiungere le righe seguenti al file mkdocs.yml
markdown_extensions:
- pymdownx.caret
- pymdownx.tilde
Esempio:
- H~2~0
- A^T^A
Risultato:
- H20
- ATA
Grafici↵
È possibile generarli grazie a Mermaid, che dalla versione 8.2 di Material for MkDocs è nativamente disponibile.
Ad esempio con
``` mermaid
graph TD
A[Quattro Chiacchiere] --> B[con]
B --> C[Ciro]
B --> D[Totò]
B --> E[andy]
B --> F[Gianni]
```
si ottiene
graph TD
A[Quattro Chiacchiere] --> B[con]
B --> C[Ciro]
B --> D[Totò]
B --> E[andy]
B --> F[Gianni]Aggiungere le righe seguenti al file mkdocs.yml
Per generarli bisogna configurare Material for Mkdocs in questo modo.
Contenuti divisi in tab↵
A volte, è preferibile raggruppare contenuti alternativi in schede diverse, ad es. quando si descrive come accedere a un'API da linguaggi o ambienti diversi: come l'esempio di sotto:
#include <stdio.h>
int main(void) {
printf("Hello world!\n");
return 0;
}
#include <iostream>
int main(void) {
std::cout << "Hello world!" << std::endl;
return 0;
}
Per attivare questa funzione, bisogna aggiungere questi parametri al file di configurazione mkdocs.yaml:
markdown_extensions:
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
L'esempio di sopra si ottiene con questo codice:
=== "C"
``` c
#include <stdio.h>
int main(void) {
printf("Hello world!\n");
return 0;
}
```
=== "C++"
``` c++
#include <iostream>
int main(void) {
std::cout << "Hello world!" << std::endl;
return 0;
}
```