Guida alla Documentazione API

Ultimo Aggiornamento   27 aprile 2025

Guide

FAQ per Sviluppatori

Come è strutturato il progetto?

Struttura dei File

Starlight cerca file .md o .mdx nella directory src/content/docs/. Ogni file viene esposto come route basata sul nome del file.

Le immagini possono essere aggiunte a src/assets/ e incorporate nel Markdown con un link relativo.

Gli asset statici, come le favicon, possono essere posizionati nella directory public/.

• Directorypublic favicon e altri asset statici

  • …
• Directorysrc

  • Directoryassets Immagini per le pagine di documentazione

    • …
  • Directorycomponents Componenti custom

    • DirectoryGraphQLExplorer

      • GraphQLExplorer.astro File principale del componente GraphQL Explorer
      • …
    • Directoryui componenti shadcn/ui

      • …
    • …
  • Directorycontent

    • Directorydocs file mdx che generano pagine di documentazione

      • Directoryapi

        • DirectoryGraphQL

          • DirectorySchema Schema dati

            • …
        • …
        • Directoryguides Guide e tutorial

          • …
        • getting-started.mdx
        • …
      • Directorycontributing Linee guida per contribuire

        • …
      • Directoryit Traduzioni in italiano

        • …
      • Directorylibrarians Guide per bibliotecari

        • …
      • ui.json traduzioni per le stringhe UI
  • Directorylayouts Layout per pagine di documentazione

    • documentation.astro Layout principale per pagine di documentazione
    • …
• astro.config.mjs File di configurazione Astro
• components.json componenti shadcn/ui
• CONTRIBUTING Linee guida per contribuire
• DEVELOPERS.md FAQ per sviluppatori
• tailwind.config.mjs Configurazione Tailwind CSS
• …

Come eseguo il progetto in locale?

🚀 Avvio Rapido

1. Clona il repo:

git clone https://github.com/hardcoverapp/hardcover-docs.git

2. Naviga nella directory del progetto:

cd hardcover-docs

3. Installa le dipendenze:

npm install

4. Avvia il dev server:

npm run dev

5. Apri il browser
6. Vai a http://localhost:4321

🧞 Comandi

Il sito di documentazione di Hardcover è costruito con Astro. Tutti i comandi vengono eseguiti dalla root del progetto, da un terminale:

Comando	Azione
npm install	Installa le dipendenze
npm run dev	Avvia il dev server locale su localhost:4321
npm run build	Fai una build di produzione in ./dist/
npm run preview	Vedi un’anteprima della build in locale, prima del deploy
npm run astro ...	Esegui comandi CLI come astro add, astro check
npm run astro -- --help	Ottieni aiuto utilizzando la CLI di Astro
npx vitest	Esegui gli unit tests per il progetto
npx vitest --coverage.enabled true	Esegui gli unit test con coverage

Come aggiungo una nuova pagina o aggiorno una pagina esistente?

Aggiungere una Nuova Pagina

1. Crea un nuovo file .mdx nella directory src/content/docs/.
2. Dai al file un nome che descriva il contenuto.
3. Aggiungi il frontmatter in cima al file.
4. Aggiungi contenuto al file utilizzando la sintassi Markdown o MDX.
5. Aggiungi la nuova pagina alla barra laterale

• Se la pagina fa parte delle sezioni api/GraphQL/Schema o guides, la barra laterale si aggiornerà automaticamente con la nuova pagina.
• Tutte le altre pagine dovranno essere aggiunte al file di configurazione astro vedi Starlight - Aggiungi collegamenti e gruppi di collegamenti per maggiori informazioni.

Page Frontmatter

Spostato a Frontmatter

Componenti Disponibili

Spostato a Astro Components per i componenti Astro e React Components per i componenti React.

Tradurre Contenuto

Spostato a to Translating Documentation Guide

Risorse di Supporto

Inviare un Bug Report

Richiedere una Funzionalità

Trovare Aiuto su Discord

Connettiti con noi su Discord