Salta ai contenuti

Come iniziare

Starlight è un tema di documentazione completo di funzionalità costruito sulla base del framework Astro. Questa guida ti aiuterà a iniziare con un nuovo progetto. Consulta le istruzioni di configurazione manuale per aggiungere Starlight a un progetto Astro esistente.

Avvio Rapido

Crea un nuovo progetto

Crea un nuovo progetto Astro + Starlight eseguendo il seguente comando nel tuo terminale:

Terminal window
npm create astro@latest -- --template starlight

Questo creerà una nuova directory di progetto con tutti i file e le configurazioni necessari per il tuo sito.

Avvia il server di sviluppo

Quando lavori in locale, il server di sviluppo di Astro ti consente di visualizzare in anteprima il tuo lavoro e aggiorna automaticamente il browser quando apporti modifiche.

All’interno della directory del progetto, esegui il seguente comando per avviare il server di sviluppo:

Terminal window
npm run dev

Questo registrerà un messaggio nel tuo terminale con l’URL dell’anteprima locale. Apri questo URL per iniziare a navigare nel tuo sito.

Aggiungi contenuti

Starlight è pronto per aggiungere nuovi contenuti o portare i tuoi file esistenti!

Formato dei file

Starlight supporta la creazione di contenuti in Markdown e MDX senza necessità di configurazione. Puoi aggiungere il supporto per Markdoc installando l’integrazione Astro Markdoc sperimentale.

Aggiungi pagine

Aggiungi nuove pagine al tuo sito creando file .md o .mdx in src/content/docs/. Usa le sottocartelle per organizzare i tuoi file e per creare più segmenti di percorso.

Ad esempio, la seguente struttura di file genererà le pagine example.com/hello-world e example.com/guides/faq:

  • Directorysrc/
    • Directorycontent/
      • Directorydocs/
        • Directoryguides/
          • faq.md
        • hello-world.md

Frontmatter type-safe

Tutte le pagine di Starlight condividono un insieme comune di proprietà frontmatter personalizzabili per controllare il modo in cui viene visualizzata la pagina:

---
title: Ciao Mondo!
description: Questa è una pagina nel mio sito potenziato da Starlight
---

Se dimentichi qualcosa di importante, Starlight te lo farà sapere.

Prossimi passi

Aggiorna Starlight

Starlight è un’integrazione Astro. Puoi aggiornarlo e aggiornare altri pacchetti Astro eseguendo il seguente comando nel tuo terminale:

Terminal window
npx @astrojs/upgrade

Consulta il changelog di Starlight per un elenco completo delle modifiche apportate in ogni versione.

Risoluzione dei problemi di Starlight

Usa le pagine di riferimento della configurazione del progetto e della configurazione frontmatter della singola pagina per assicurarti che il tuo sito Starlight sia configurato e funzionante correttamente. Consulta le guide nella barra laterale per aiutarti ad aggiungere contenuti e personalizzare il tuo sito Starlight.

Se la tua risposta non può essere trovata in questa documentazione, visita la documentazione completa di Astro per la documentazione completa di Astro. La tua domanda potrebbe trovare risposta comprendendo il funzionamento generale di Astro, sotto questo tema Starlight.

Puoi anche controllare eventuali problemi noti di Starlight su GitHub e ottenere aiuto nel Discord di Astro dalla nostra comunità attiva e amichevole! Pubblica domande nel nostro forum #support con il tag “starlight” o visita il nostro canale dedicato #starlight per discutere degli sviluppi attuali e di altro ancora!