Riferimenti frontmatter
Puoi personalizzare pagine Markdown e MDX in Starlight definendo i valori nel frontmatter. Per esempio, una pagina potrebbe definire title
e description
:
---
title: A proposito del progetto
description: Scopri di più sul progetto a cui sto lavorando.
---
Benvenuto alla pagina "a proposito del progetto"!
Campi del frontmatter
title
(obbligatorio)
type: string
Devi fornire un titolo ad ogni pagina. Questo sarà usato in testa alla pagina, nelle finestre del browser e nei metadati della pagina.
description
type: string
La descrizione è utilizzata nei metadati e sarà utilizzata dai motori di ricerca e nelle anteprime nei social.
editUrl
type: string | boolean
Sovrascrive la configurazione globale editLink
. Metti a false
per disabilitare “Modifica la pagina” per quella pagina specifica oppure fornisci un link alternativo.
head
type: HeadConfig[]
Puoi aggiungere tag aggiuntivi nell’<head>
della pagina utilizzando la chiave head
nel frontmatter. Questo significa che puoi aggiungere stili personalizzati, metadati o altri tag in una pagina. Il funzionamento è simile all’opzione globale head
.
---
title: Chi siamo
head:
# Utilizza un <title> personalizzato
- tag: title
content: Titolo personalizzato
---
tableOfContents
type: false | { minHeadingLevel?: number; maxHeadingLevel?: number; }
Sovrascrive la configurazione globale tableOfContents
.
Cambia i livelli di titoli inclusi o, se messo a false
, nasconde la tabella dei contenuti della pagina.
template
type: 'doc' | 'splash'
default: 'doc'
Definisce il layout per la pagina.
Le pagine utilizzano 'doc'
come predefinita.
Se valorizzato a 'splash'
viene utilizzato un layout senza barre laterali ottimale per la pagina iniziale.
hero
type: HeroConfig
Aggiunge un componente hero all’inizio della pagina. Funziona bene con template: splash
.
Per esempio, questa configurazione illustra comuni opzioni, incluso il caricamento di un’immagine.
---
title: La mia pagina principale
template: splash
hero:
title: 'Il mio progetto: Stellar Stuff Sooner'
tagline: Porta le tue cose sulla Luna e torna indietro in un battito d'occhio.
image:
alt: Un logo brillante e luminoso
file: ../../assets/logo.png
actions:
- text: Dimmi di più
link: /getting-started/
icon: right-arrow
variant: primary
- text: Vedi su GitHub
link: https://github.com/astronaut/my-project
icon: external
---
HeroConfig
interface HeroConfig {
title?: string;
tagline?: string;
image?: {
alt?: string;
// Percorso relativo ad un’immagine dentro il tuo progetto.
file?: string;
// HTML non elaborato da utilizzare al posto dell'immagine.
// Potrebbe essere un tag personalizzato `<img>` o `<svg>` in linea.
html?: string;
};
actions?: Array<{
text: string;
link: string;
variant: 'primary' | 'secondary' | 'minimal';
icon: string;
}>;
}