Visão geral dos componentes
Conheça os componentes MDX do Jamdesk, incluindo cards, abas, avisos e blocos de código, para encontrar o melhor recurso para o seu conteúdo de documentação.
O Jamdesk inclui componentes MDX que você pode usar em qualquer página.
Uso
Adicione componentes ao seu MDX:
<Card title="Quickstart" icon="rocket" href="/quickstart">
Launch your docs in minutes.
</Card>
Layout e navegação
Seções de conteúdo recolhíveis que os leitores expandem para ver detalhes. Use-as para perguntas frequentes, listas de recursos e opções de configuração.
Contêineres estilizados e clicáveis, com ícones, imagens, links e CTAs, organizados em layouts de grade.
Layout de grade responsivo que posiciona Cards, Tiles e outros conteúdos lado a lado. Ele se adapta ao tamanho da tela.
O Frame envolve imagens e demonstrações em um contêiner com borda e legenda opcional.
Fixe conteúdo personalizado, como avisos ou referências rápidas, na barra lateral, onde ele permanece visível enquanto o leitor rola a página.
Guias numerados passo a passo para fluxos de configuração, tutoriais e solução de problemas, com ícones, blocos de código e conteúdo aninhado.
Painéis alternáveis para conteúdos mutuamente exclusivos, como gerenciadores de pacotes ou linguagens. Títulos de abas iguais são sincronizados em toda a página.
Tiles exibem prévias de conteúdo com um fundo de padrão estilizado e uma área de imagem em destaque. Use-os para integrações, modelos ou galerias visuais.
Exiba hierarquias de arquivos e pastas com expansão/recolhimento interativos e navegação por teclado. Use-o para documentar a estrutura do projeto.
Mostre conteúdo para o framework ou a linguagem escolhida pelo leitor. Seções inteiras mudam conforme a seleção.
Conteúdo e destaque
Rótulos inline para status, categorias e metadados, com 11 variantes de cor, 4 tamanhos, ícones, formatos pill/arredondado e contornos de traço.
Componentes Note, Tip, Warning, Danger, Check e Callout personalizados que destacam informações importantes.
O Expandable cria um alternador de mostrar/ocultar para conteúdo opcional fora do fluxo principal.
Exiba definições e contexto ao passar o mouse. Defina termos, explique siglas ou crie links para conteúdos relacionados sem sobrecarregar a página.
Entradas de changelog em formato de linha do tempo, com datas, descrições e tags de categoria. As entradas aparecem no Sumário.
Mostre conteúdos diferentes para leitores humanos e agentes de IA na mesma página. Contexto, instruções e definições exclusivos para agentes que não aparecem na documentação renderizada.
Código e dados
Exiba blocos de código em uma interface com abas. Mostre a mesma operação em várias linguagens, como cURL, Python e JavaScript.
Fixe blocos de código, com abas de linguagem opcionais, em uma barra lateral direita fixa que permanece visível enquanto o leitor rola a página no desktop.
Documente parâmetros de API e campos de resposta com os componentes ParamField e ResponseField, incluindo tipos, valores padrão e objetos aninhados.
Use o Prompt para apresentar instruções de IA reutilizáveis, com copiar, ações de abrir em outro aplicativo integradas, destinos personalizados, ícones e opções de exibição compactas.
Organize dados em linhas e colunas. Use tabelas Markdown ou componentes Table com ordenação, destaque e mesclagem de células.
Diagramas e recursos visuais
O componente Color exibe paletas de cores para sistemas de design, diretrizes de marca ou qualquer especificação de cor.
Renderize fluxogramas, diagramas de sequência, linhas do tempo, gráficos de pizza e mais a partir da sintaxe de texto do Mermaid. Os diagramas são gerados como SVG no momento do build.
Renderize diagramas de arquitetura, fluxogramas, sequências e modelos SQL a partir da sintaxe de texto do D2. Os diagramas são renderizados como SVG que segue o tema do site.
Engajamento
Adicione um formulário de inscrição em newsletter ou changelog a qualquer página da documentação com o componente EmailSubscribe: captura nativa para sete provedores e embeds para os demais.
Incorpore uma demonstração ao vivo do widget What's New na sua documentação com o componente MDX Widget: um botão de disparo que abre seu changelog em um modal, sem necessidade de tag script.
