Panoramica dei componenti
Scopri i componenti MDX di Jamdesk, tra cui card, schede, avvisi e blocchi di codice, per trovare quelli più adatti al tuo contenuto di documentazione.
Jamdesk include componenti MDX utilizzabili in qualsiasi pagina.
Utilizzo
Aggiungi componenti al tuo MDX:
<Card title="Quickstart" icon="rocket" href="/quickstart">
Launch your docs in minutes.
</Card>
Layout e navigazione
Sezioni di contenuto comprimibili che i lettori espandono per i dettagli. Usale per FAQ, elenchi di funzionalità e opzioni di configurazione.
Contenitori cliccabili e stilizzati con icone, immagini, link e CTA, disposti in layout a griglia.
Layout a griglia reattivo che affianca Card, Tile e altri contenuti. Si adatta alle dimensioni dello schermo.
Frame racchiude immagini e demo in un contenitore con bordo e didascalia facoltativa.
Fissa contenuti personalizzati come avvisi o riferimenti rapidi nella barra laterale, dove restano visibili durante lo scorrimento.
Guide passo-passo numerate per procedure di configurazione, tutorial e risoluzione dei problemi, con icone, blocchi di codice e contenuti annidati.
Pannelli commutabili per contenuti alternativi come gestori di pacchetti o linguaggi. I titoli delle schede corrispondenti si sincronizzano in tutta la pagina.
Le Tile mostrano anteprime di contenuto con uno sfondo a motivo stilizzato e un'area immagine evidente. Usale per integrazioni, template o gallerie visive.
Mostra gerarchie di file e cartelle con espansione/compressione interattiva e navigazione da tastiera. Usalo per documentare la struttura di un progetto.
Mostra il contenuto per il framework o il linguaggio scelto dal lettore. Intere sezioni cambiano in base alla selezione.
Contenuti ed enfasi
Etichette inline per stato, categorie e metadati, con 11 varianti di colore, 4 dimensioni, icone, forme pill/arrotondate e contorni a tratto.
Componenti Note, Tip, Warning, Danger, Check e Callout personalizzati che evidenziano le informazioni chiave.
Expandable crea un interruttore mostra/nascondi per contenuti facoltativi al di fuori del flusso principale.
Mostra definizioni e contesto al passaggio del mouse. Definisci termini, spiega acronimi o rimanda a contenuti correlati senza appesantire la pagina.
Voci di changelog in stile timeline con date, descrizioni ed etichette di categoria. Le voci compaiono nell'indice.
Mostra contenuti diversi ai lettori umani e agli agenti AI nella stessa pagina. Contesto, istruzioni e definizioni riservati agli agenti che restano fuori dalla documentazione visualizzata.
Codice e dati
Mostra blocchi di codice in un'interfaccia a schede. Visualizza la stessa operazione in più linguaggi come cURL, Python e JavaScript.
Fissa blocchi di codice, con schede linguaggio facoltative, in una barra laterale destra sticky che resta visibile durante lo scorrimento su desktop.
Documenta parametri API e campi di risposta con i componenti ParamField e ResponseField, includendo tipi, valori predefiniti e oggetti annidati.
Usa Prompt per presentare istruzioni AI riutilizzabili con copia, azioni di apertura integrate, destinazioni personalizzate, icone e opzioni di visualizzazione compatte.
Organizza i dati in righe e colonne. Usa tabelle Markdown o componenti Table con ordinamento, evidenziazione e celle unite.
Diagrammi ed elementi visivi
Il componente Color mostra palette di colori per sistemi di design, linee guida del brand o qualsiasi specifica cromatica.
Genera flowchart, diagrammi di sequenza, timeline, grafici a torta e altro a partire dalla sintassi testuale Mermaid. I diagrammi vengono costruiti come SVG in fase di build.
Genera diagrammi di architettura, flowchart, sequenze e modelli SQL dalla sintassi testuale D2. I diagrammi vengono resi come SVG che segue il tema del sito.
Coinvolgimento
Aggiungi a qualsiasi pagina della documentazione un modulo di iscrizione alla newsletter o al changelog con il componente EmailSubscribe: acquisizione nativa per sette provider, embed per gli altri.
Incorpora nella documentazione una demo live del widget What's New con il componente MDX Widget: un pulsante che apre il changelog in una modale, senza bisogno di tag script.
