Panoramica componenti
Esplora i componenti MDX di Jamdesk, tra card, schede, callout e blocchi di codice, per scegliere quelli più adatti alla tua documentazione.
Jamdesk include componenti MDX utilizzabili in qualsiasi pagina. Questa panoramica ti aiuta a scegliere il componente più adatto ai tuoi contenuti.
Utilizzo
Inserisci direttamente i componenti nel tuo MDX:
<Card title="Quickstart" icon="rocket" href="/quickstart">
Launch your docs in minutes.
</Card>Layout e navigazione
Sezioni di contenuto comprimibili che consentono agli utenti di espandere solo ciò che serve. Ideali per FAQ, elenchi di funzionalità e opzioni di configurazione.
Scopri come usare il componente Card per creare contenitori cliccabili e stilizzati con icone, immagini, link e CTA nei layout a griglia.
Layout a griglia reattivo per visualizzare Cards, Tiles e altri contenuti affiancati. Si adatta automaticamente alle dimensioni dello schermo.
Frame racchiude immagini e demo in un contenitore con bordo e didascalie opzionali, mantenendo uniformi gli elementi visivi della documentazione.
Usa Panel per fissare contenuti personalizzati, come avvisi o riferimenti rapidi, nella barra laterale, mantenendoli visibili mentre i lettori scorrono.
Guide numerate passo passo per flussi di configurazione, tutorial e risoluzione dei problemi. Supporta icone, blocchi di codice e contenuti nidificati.
Pannelli intercambiabili per contenuti mutuamente esclusivi, come gestori di pacchetti o linguaggi. I titoli delle schede corrispondenti vengono sincronizzati in tutta la pagina.
I Tile mostrano anteprime dei contenuti con uno sfondo a motivi stilizzato e un'area immagine in evidenza. Usali per integrazioni, template o gallerie visive.
Visualizza gerarchie di file e cartelle con espansione/compressione interattiva e navigazione da tastiera. Ideale per documentare la struttura dei progetti.
Crea documentazione che si adatta al framework o al linguaggio scelto dal lettore. Intere sezioni cambiano in base alla selezione dell'utente.
Contenuti ed enfasi
Etichette inline per stato, categorie e metadati: 11 varianti di colore, 4 dimensioni, icone, forme a pillola o arrotondate e contorni.
Scopri come usare i componenti Note, Tip, Warning, Danger, Check e Callout personalizzati per evidenziare le informazioni chiave nella documentazione.
Expandable crea un semplice controllo per mostrare o nascondere contenuti che i lettori potrebbero voler consultare, ma che non sono essenziali al flusso principale.
Mostra definizioni e contesto al passaggio del mouse. Definisci termini, spiega acronimi o collega contenuti correlati senza appesantire la pagina.
Voci del changelog in stile timeline con date, descrizioni e tag di categoria. Si integra con l'indice dei contenuti per la navigazione.
Mostra contenuti diversi ai lettori umani e agli agenti AI nella stessa pagina. Contesto, istruzioni e definizioni riservati agli agenti restano esclusi dalla documentazione visualizzata.
Codice e dati
Visualizza blocchi di codice in un'interfaccia a schede. Mostra la stessa operazione in più linguaggi, come cURL, Python e JavaScript.
Fissa i blocchi di codice in una barra laterale destra persistente su desktop, così i lettori possono consultarli durante lo scorrimento. Supporta linguaggi a schede.
Documenta i parametri API e i campi delle risposte con i componenti ParamField e ResponseField. Supporta tipi, valori predefiniti e oggetti nidificati.
Usa Prompt per presentare istruzioni AI riutilizzabili con copia, azioni integrate di apertura, destinazioni personalizzate, icone e opzioni di visualizzazione compatta.
Organizza i dati in righe e colonne. Supporta tabelle Markdown e componenti Table con ordinamento, evidenziazione e celle estese.
Diagrammi ed elementi visivi
Il componente Color mostra tavolozze di colori per documentare sistemi di progettazione, linee guida del brand o qualsiasi specifica cromatica.
Esegui diagrammi di flusso, diagrammi di sequenza, timeline, grafici a torta e altro ancora dalla sintassi Mermaid basata sul testo. I diagrammi vengono creati come SVG durante la fase di build.
Esegui diagrammi di architettura, diagrammi di flusso, sequenze e modelli SQL dalla sintassi D2 basata sul testo. I diagrammi vengono creati come SVG con temi chiaro e scuro automatici.
Coinvolgimento
Aggiungi un modulo di iscrizione a newsletter o changelog a qualsiasi pagina della documentazione con il componente EmailSubscribe: acquisizione nativa per sette provider e incorporamenti per gli altri.
Incorpora una demo live del widget What's New nella documentazione con il componente MDX Widget: un pulsante di attivazione che apre il changelog in una finestra modale, senza bisogno di un tag script.