Avvio rapido: deploy in 5 min

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

Pubblica un sito di documentazione con soli due file: docs.json e una pagina MDX. Scegli il percorso in base 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

Il modo più rapido per iniziare. Il template starter include contenuti di esempio, una specifica OpenAPI ed esempi di ogni componente, così puoi vedere come funzionano prima di sostituirli 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. La guida illustra il comando jamdesk migrate per Mintlify e i passaggi manuali per gli altri strumenti di documentazione. Dopo la migrazione, collega il repository migrato usando l'opzione 2.

Contenuto di un progetto Docs

Un progetto Jamdesk minimo contiene due elementi:

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

Per i siti più grandi, consulta Struttura delle directory per cartelle, asset e snippet consigliati.

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 di 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 di base su MDX per frontmatter, titoli, link e sintassi dei componenti.

Sviluppo locale

La CLI di Jamdesk ti consente di visualizzare in anteprima le modifiche localmente prima di eseguire il push su GitHub. È utile per individuare gli errori di sintassi MDX prima che raggiungano il sito online. Per tutti i metodi di installazione e i comandi, consulta la panoramica della CLI di Jamdesk.

Visualizza le modifiche in anteprima localmente:

npm install -g jamdesk
cd my-docs
jamdesk dev

Apri http://localhost:3000 per visualizzare la documentazione con l'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. Esegui il push su GitHub: la nuova pagina verrà pubblicata automaticamente.

Per altri modelli di collegamento, inclusi anchor e schede, consulta Link e navigazione.

Dominio personalizzato

Aggiungi il tuo dominio in Settings → Domains:

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

I certificati SSL vengono forniti automaticamente. Guida completa →

Hai bisogno di aiuto?

Hai un problema? Consulta il Centro assistenza per le guide alla configurazione, alla fatturazione e alla risoluzione dei problemi. Oppure parla con una persona: apri il widget della chat nell'angolo inferiore di qualsiasi pagina Jamdesk o inviaci un'email all'indirizzo support@jamdesk.com. Rispondiamo rapidamente.

Riferimento completo

Tutto ciò che puoi creare ed eseguire è descritto in tre riferimenti: ogni componente MDX, ogni comando della CLI e ogni opzione di configurazione di docs.json.

Qual è il prossimo passo?