Crea un progetto

Prima di scrivere la documentazione devi avere un progetto. Puoi partire da un modello (Jamdesk crea il repository per te, su GitHub o Bitbucket Cloud) oppure collegare un repository esistente che contiene già un docs.json. In entrambi i casi, il tuo sito sarà online in pochi minuti.

Crea un nuovo progetto

Accedi a Jamdesk

Vai a dashboard.jamdesk.com e accedi con il tuo account GitHub.

Al primo accesso ti verrà chiesto di autorizzare la GitHub App di Jamdesk.

Fai clic su New Project

Dal dashboard, fai clic su New Project nell'angolo in alto a destra.

Scegli un punto di partenza

Inizia con un modello predefinito. Jamdesk crea per te un nuovo repository GitHub con contenuti di esempio, navigazione e componenti già configurati.

Lo Starter Template predefinito include pagine di esempio, una specifica OpenAPI ed esempi di ogni componente. Sostituisci i contenuti con i tuoi e il gioco è fatto.

Configura le impostazioni del progetto

Imposta le informazioni di base del progetto:

Campo	Descrizione
Name	Nome visualizzato nel dashboard
Slug	Identificatore adatto agli URL (ad esempio, `my-docs`)
Domain	Il tuo sottodominio `*.jamdesk.app`

Struttura minima del repository

Un progetto Jamdesk richiede solo un docs.json e almeno una pagina:

my-docs/
├── docs.json
└── introduction.mdx

Esempio di docs.json:

docs.json

{
  "$schema": "https://jamdesk.com/docs.json",
  "name": "My Docs",
  "theme": "jam",
  "navigation": {
    "groups": [
      {
        "group": "Getting Started",
        "pages": ["introduction"]
      }
    ]
  }
}

Impostazioni del progetto

Dopo la creazione, configura il progetto in Settings:

Generali

Name - Aggiorna il nome visualizzato
Slug - Modifica l'identificatore del progetto
Delete Project - Rimuovi definitivamente il progetto

Repository

Branch - Il branch che attiva i deploy
Docs Path - Posizione di docs.json per i monorepo

Dominio

Subdomain - Il tuo URL *.jamdesk.app
Custom Domain - Aggiungi il tuo dominio
Host at a subpath - Pubblica la documentazione in un percorso come /docs o /help invece che nella radice del sito

Build

Show Jamdesk Branding - Mostra il link "Powered by Jamdesk" nel piè di pagina (abilitato per impostazione predefinita)
Rebuild - Avvia manualmente una nuova build

Le modifiche alle impostazioni di build richiedono una nuova build per diventare effettive.

Limiti dei progetti

Piano	Progetti	Build/mese
Free	1	100
Pro	10	Unlimited
Team	Unlimited	Unlimited

E adesso?

Collega GitHub

Collega il tuo repository per build automatiche

Struttura delle directory

Organizza la documentazione per progetti di grandi dimensioni

Configurazione monorepo

Configura il percorso della documentazione per i monorepo

Tutorial completo

Segui il flusso di lavoro completo di Jamdesk