Creazione di contenuti in Markdown
Starlight supporta l’intera sintassi Markdown nei file .md
insieme al frontmatter YAML per definire metadati come il titolo e la descrizione.
Assicurarsi di guardare la documentazione MDX o la documentazione Markdoc se si vogliono usare questi formati, dato che il supporto Markdown può variare.
Stili in linea
Il testo può essere grassetto, corsivo, o barrato.
Puoi aggiungere un link ad un’altra pagina.
Puoi evidenziare codice in linea
con apici inversi.
Immagini
Le immagini in Starlight utilizzano l’ottimizzazione degli asset di Astro.
Markdown e MDX supportano la sintassi Markdown per rappresentare immagini che includono testo alternativo per le tecnologie assistive.
I percorsi relativi sono supportati per immagini salvate localmente nel tuo progetto.
Titoli
Puoi strutturare i contenuti utilizzando dei titoli. In Markdown sono indicati dal numero di #
all’inizio della linea.
Come strutturare i contenuti della pagina in Starlight
Starlight è configurato per utilizzare automaticamente il titolo della pagina come intestazione e includerà una “Panoramica” in alto per ogni tabella dei contenuti. Si raccomanda di iniziare ogni pagina con un paragrafo e di usare titoli a partire da <h2>
:
Link titoli automatici
Utilizzando titoli in Markdown verranno generati automaticamente i rispettivi link per navigare velocemente in certe sezioni della tua pagina:
Titoli di livello 2 (<h2>
) e di livello 3 (<h3>
) verranno inclusi automaticamente nella tabella dei contenuti.
Aside
Gli aside (conosciuti anche come “ammonizioni” o “richiami”) sono utili per indicare contenuti secondari insieme ai contenuti principali.
Starlight fornisce una sintassi Markdown personalizzata per indicarli. I blocchi aside sono indicati da :::
per racchiudere i contenuti e possono essere di tipo note
, tip
, caution
o danger
.
Dentro un “aside” puoi inserire qualsiasi altro contenuto Markdown anche se sono più indicati per contenere poche informazioni.
Note aside
Titoli aside personalizzati
Si può specificare un titolo personalizzato per gli aside in parentesi quadre dopo aver specificato il tipo di aside, per esempio :::tip[Lo sapevi?]
.
Altri tipi di aside
Gli aside caution e danger sono d’aiuto per richiamare l’attenzione dell’utente a dettagli che potrebbero sorprenderli. Se ti ritrovi ad usarli spesso, potrebbe essere segno che quelo che stai documentando potrebbe trarre beneficio da una riprogettazione.
Citazioni
Questo è un blockquote, che di solito viene utilizzato per citazioni di persone o documenti.
I blockquote sono indicati da
>
all’inizio di ogni riga.
Blocchi codice
Un blocco di codice è indicato da tre backtick ```
all’inizio e alla fine. Puoi indicare il linguaggio di programmazione dopo i primi backtick.
Altre funzionalità Markdown utili
Starlight supporta tutte le altre funzionalità Markdown, come liste e tabelle. Guarda la Markdown Cheat Sheet da The Markdown Guide per una panoramica veloce su tutte le funzionalità Markdown.