Avvio rapido: deploy in 5 minuti

Jamdesk è un software per la documentazione che pubblica un repository GitHub di Markdown come sito di documentazione ospitato. Genera automaticamente output leggibile dall'AI: llms.txt, endpoint .md per ogni pagina e un server MCP.

Distribuisci un sito di documentazione con due file: docs.json e una pagina MDX. Scegli il percorso che corrisponde al tuo punto di partenza.

Prerequisiti

Ti serviranno:

• Un account GitHub
• Un repository con la tua documentazione (oppure ne creeremo uno)

Opzione 1: parti dal template Starter

Questo è il modo più rapido per iniziare. Lo starter template include contenuti di esempio, una specifica OpenAPI ed esempi di ogni componente. Osserva come funziona, poi sostituiscili con i tuoi contenuti.

Opzione 2: collega un repository esistente

Hai già un repository con documentazione pronta per Jamdesk? Collegalo direttamente. Se stai migrando da Mintlify o da un'altra piattaforma di documentazione, usa prima l'Opzione 3.

Opzione 3: esegui la migrazione da Mintlify o da un'altra piattaforma

Hai già documentazione in Mintlify, GitBook, Docusaurus, ReadMe, Confluence o un'altra piattaforma? Inizia dalla guida alla migrazione prima di creare un nuovo progetto. Essa copre il comando jamdesk migrate per Mintlify e i passaggi manuali per gli altri strumenti di documentazione. Poi collega il repository migrato usando l'Opzione 2.

Contenuto di un progetto Docs

Un progetto Jamdesk minimo ha due elementi:

my-docs/
├── docs.json           # Configuration
└── introduction.mdx    # Your first page

Per siti più grandi, consulta Struttura delle directory per le cartelle consigliate, gli asset e gli snippet.

docs.json

Il file di configurazione che definisce il tuo sito:

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

Consulta il Riferimento docs.json per tutte le opzioni di configurazione.

Pagine MDX

Pagine di documentazione scritte in MDX:

---
title: Introduction
description: Welcome to the docs
---

# Welcome

This is your first documentation page.

Consulta Nozioni base MDX per frontmatter, titoli, link e sintassi dei componenti.

Sviluppo locale

Visualizza in anteprima le modifiche in locale con la CLI Jamdesk prima di fare push su GitHub. Intercetta gli errori di sintassi MDX prima che raggiungano il sito live. Consulta la panoramica della CLI Jamdesk per ogni metodo di installazione e comando.

Avvialo:

npm install -g jamdesk
cd my-docs
jamdesk dev

Apri http://localhost:3000 per vedere la tua documentazione con hot reload.

Aggiungi altre pagine

1. Crea un nuovo file MDX:

---
title: Getting Started
description: Learn the basics
---

Your content here...

2. Aggiungilo a docs.json:

{
  "navigation": {
    "groups": [
      {
        "group": "Getting Started",
        "pages": ["introduction", "getting-started"]
      }
    ]
  }
}

3. Fai push su GitHub. La tua nuova pagina viene distribuita automaticamente.

Per altri schemi di link, incluse ancore e card, consulta Link e navigazione.

Dominio personalizzato

Aggiungi il tuo dominio in Settings → Domains:

1. Inserisci il tuo dominio (ad es. docs.example.com)
2. Aggiungi i record DNS mostrati
3. Attendi la verifica (fino a 48 ore)

I certificati SSL vengono generati automaticamente. Guida completa →

Hai bisogno di aiuto?

Consulta il Centro assistenza per guide su configurazione, fatturazione e risoluzione dei problemi. Per parlare con una persona, apri il widget di chat nell'angolo in basso di qualsiasi pagina Jamdesk, oppure scrivi a support@jamdesk.com. Rispondiamo rapidamente.

Riferimento completo

I riferimenti coprono ogni componente MDX, ogni comando CLI e ogni opzione di configurazione docs.json.

Qual è il prossimo passo?