Panoramica configurazione progetto

Un sito Jamdesk è un progetto nella dashboard, un repo GitHub alla base e un file docs.json che descrive la navigazione. Questa sezione tratta la configurazione. Definisci presto la struttura degli URL, le lingue e il controllo degli accessi. Sono più difficili da modificare quando hai cinquanta pagine.

Per passare da un'altra piattaforma, consulta la Guida alla migrazione.

Dal repository al sito online

Crea un progetto

Parti da un template oppure collega un repo GitHub esistente. Il tuo sito sarà online su yourproject.jamdesk.app.

Collega GitHub

Installa la GitHub App così ogni push viene distribuito automaticamente.

Organizza il repo

Aggiungi un file docs.json e le pagine MDX.

Configurazione principale

Crea un progetto

Da un template o da un repo esistente fino a un sito online

Collega GitHub

Installazione dell'app, accesso ai repository e distribuzione automatica a ogni push

Struttura delle directory

File richiesti, directory delle pagine, immagini e snippet

Guida alla migrazione

Passa da un'altra piattaforma di documentazione, in modo automatico o manuale

Supporto monorepo

Tieni la documentazione accanto al codice quando non si trova nella radice del repo

Supporto multilingua

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

Struttura del sito

Navigazione

Tab, 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

Blocca l'intero sito o alcune pagine dietro una password condivisa

Single Sign-On (SSO)

SAML o OIDC tramite il tuo provider di identità