Configurazione progetto

Ogni sito Jamdesk inizia allo stesso modo: un progetto nel dashboard, un repository GitHub collegato e un file docs.json che descrive la navigazione. Questa sezione illustra la configurazione iniziale e le decisioni strutturali da prendere fin dall'inizio. È molto più semplice definire la struttura degli URL, le lingue e il controllo degli accessi prima di avere cinquanta pagine.

Stai effettuando la migrazione da un'altra piattaforma? Vai direttamente alla guida alla migrazione. Jamdesk può automatizzare gran parte della conversione.

Dal repository al sito online

Crea un progetto

Parti da un template o collega un repository GitHub esistente. Il sito sarà online all'indirizzo yourproject.jamdesk.app.

Collega GitHub

Installa l'app GitHub per distribuire automaticamente ogni push.

Organizza il repository

Un file docs.json più le pagine MDX. Questo è tutto ciò che serve.

Configurazione principale

Crea un progetto

Da un template o da un repository esistente a un sito online

Collega GitHub

Installazione dell'app, accesso al repository e deploy automatici a ogni push

Struttura delle directory

File obbligatori, directory delle pagine, immagini e snippet

Guida alla migrazione

Passa da un'altra piattaforma di documentazione, automaticamente o manualmente

Supporto ai monorepo

Mantieni la documentazione accanto al codice quando non si trova nella radice del repository

Supporto multilingue

Pubblica la documentazione in più lingue con un selettore della lingua

Struttura del sito

Navigazione

Schede, gruppi e pagine che organizzano la documentazione

Reindirizzamenti

Reindirizzamenti esatti e basati su pattern per pagine spostate o rinominate

Privacy e accesso

Controllo degli accessi

Completamente pubblico, protetto da password, misto o SSO. Confronta le opzioni.

Protezione con password

Proteggi l'intero sito o solo alcune pagine con una password condivisa

Single Sign-On (SSO)

SAML o OIDC tramite il tuo provider di identità