Crea un progetto

Prima di scrivere qualsiasi documentazione ti serve un progetto. Parti da un template per far creare a Jamdesk il repository su GitHub o Bitbucket Cloud. Oppure collega un repository esistente che contiene già un docs.json. Il tuo sito sarà online in pochi minuti. Per iniziare senza un account GitHub, consulta Documentazione senza GitHub.

Crea un nuovo progetto

Accedi a Jamdesk

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

Al primo accesso, Jamdesk ti chiederà di autorizzare la GitHub App di Jamdesk.

Clicca su New Project

Dalla dashboard, clicca su New Project in alto a destra.

Scegli un punto di partenza

Parti da un template predefinito. Jamdesk crea un nuovo repository GitHub con contenuti di esempio, navigazione e componenti già configurati.

Lo Starter Template predefinito include pagine di esempio, una specifica OpenAPI e esempi di ogni componente. Sostituisci il contenuto con il tuo.

Configura le impostazioni del progetto

Imposta le informazioni di base del progetto:

Campo	Descrizione
Name	Nome visualizzato nella dashboard
Slug	Identificatore compatibile con gli URL (es. `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

Configura il progetto in Settings:

Generali

Name: aggiorna il nome visualizzato
Slug: modifica l'identificatore del progetto
Delete Project: elimina definitivamente il progetto

Repository

Branch: il branch che attiva le distribuzioni
Docs Path: posizione di docs.json per i monorepo

Dominio

Subdomain: il tuo URL *.jamdesk.app
Custom Domain: aggiungi un dominio personalizzato
Host at a subpath: pubblica la documentazione su un percorso come /docs o /help invece che alla radice del sito

Build

Show Jamdesk Branding: mostra il link "Powered by Jamdesk" nel footer (attivo per impostazione predefinita)
Rebuild: avvia manualmente una nuova build

Le modifiche alle impostazioni di build richiedono una nuova build per avere effetto.

Limiti dei progetti

Il piano Pro include un progetto. Puoi aggiungerne altri con i project add-on a $15/mese ciascuno.

E adesso?

Collega GitHub

Collega il repository per le build automatiche

Struttura delle directory

Organizza la documentazione per crescere

Configurazione monorepo

Configura il percorso della documentazione per i monorepo

Tutorial completo

Segui il flusso di lavoro completo di Jamdesk