Jamdesk Documentation logo

Descripción general de componentes

Explora los componentes MDX de Jamdesk (tarjetas, pestañas, llamadas y bloques de código) para encontrar el más adecuado para tu documentación.

Jamdesk incluye componentes MDX que puedes usar en cualquier página. Esta descripción general te ayuda a elegir el componente adecuado para tu contenido.

Uso

Agrega componentes directamente en tu MDX:

<Card title="Quickstart" icon="rocket" href="/quickstart">

  Launch your docs in minutes.

</Card>

Diseño y navegación

Accordion

Secciones de contenido contraíbles para que los usuarios expandan solo lo que necesitan. Ideal para FAQs, listas de funciones y opciones de configuración.

Card

Usa el componente Card para destacar contenido, enlazar a otras páginas o agrupar información relacionada en secciones.

Columnas

Diseño de cuadrícula responsiva para mostrar Cards, Tiles y otro contenido lado a lado. Se adapta automáticamente al tamaño de pantalla.

Frame

Frame envuelve imágenes y demos en un contenedor con borde y leyendas opcionales, manteniendo la consistencia visual de la documentación.

Panel

Usa Panel para fijar contenido personalizado, como advertencias o referencias rápidas, en la barra lateral, visible mientras los lectores se desplazan.

Steps

Guías numeradas paso a paso para flujos de configuración, tutoriales y solución de problemas. Admite iconos, bloques de código y contenido anidado.

Pestañas

Paneles alternables para contenido mutuamente excluyente como gestores de paquetes o lenguajes. Los títulos coincidentes se sincronizan en toda la página.

Tile

Los Tiles muestran vistas previas de contenido con fondo de patrón estilizado y área de imagen destacada. Úsalos para integraciones o galerías.

Tree

Muestra jerarquías de archivos y carpetas con expansión/colapso interactivo y navegación por teclado. Ideal para documentar la estructura de proyectos.

View

Cree documentación que se adapta al framework o idioma que elija el lector. Secciones completas cambian según la selección.

Contenido y énfasis

Badge

Etiquetas en línea para estado, categorías y metadatos -- 11 variantes de color, 4 tamaños, iconos, formas píldora/redondeadas y contornos de trazo.

Callouts

Aprende a usar Note, Tip, Warning, Danger, Check y componentes Callout personalizados para resaltar información clave en tu documentación.

Expandable

Expandable crea un simple interruptor mostrar/ocultar para contenido que los lectores pueden querer ver pero que no es esencial para el flujo principal.

Tooltip

Muestra definiciones y contexto al pasar el cursor. Define términos, explica acrónimos o enlaza a contenido relacionado sin sobrecargar la página.

Update

Entradas de changelog estilo línea de tiempo con fechas, descripciones y etiquetas de categoría. Se integra con tu Tabla de contenidos para la navegación.

Visibilidad

Muestra contenido distinto a lectores y agentes de IA. Contexto, instrucciones y definiciones para agentes, fuera de los docs renderizados.

Código y datos

CodeGroup

Muestra bloques de código en una interfaz con pestañas. Presenta la misma operación en varios lenguajes como cURL, Python y JavaScript.

Ejemplos

Ancla bloques de código en una barra lateral derecha fija en escritorio para consultarlos mientras haces scroll. Admite lenguajes en pestañas.

Campos

Documenta parámetros de API y campos de respuesta con los componentes ParamField y ResponseField. Soporta tipos, valores por defecto y objetos anidados.

Prompt

Usa Prompt para presentar instrucciones de IA reutilizables con copia, acciones de apertura integradas, destinos, iconos y opciones de vista compacta.

Tablas

Organiza datos en filas y columnas. Admite tablas markdown y componentes Table con ordenación, resaltado y combinación de celdas.

Diagramas y elementos visuales

Color

El componente Color muestra paletas de colores para documentar sistemas de diseño, guías de marca o cualquier especificación de color.

Diagramas Mermaid

Renderiza diagramas de flujo, secuencia, líneas de tiempo, gráficos circulares y más a partir de sintaxis Mermaid en texto. Se generan como SVG en el build.

Diagramas D2

Renderiza diagramas de arquitectura, flujogramas, secuencias y modelos SQL desde sintaxis D2 en texto, como SVG con temas claro y oscuro automáticos.

Interacción

EmailSubscribe

Añade un formulario de suscripción a newsletter o changelog con EmailSubscribe: captura nativa para siete proveedores, embeds para el resto.

Widget

Incrusta una demo del widget What's New en tus docs con el componente MDX Widget: un botón que abre tu changelog en un modal, sin script.