Jamdesk Documentation logo

Fundamentos de MDX

Escreva documentação em Markdown com componentes React incorporados, como Card, Tabs e Accordion. Esta é a sintaxe por trás de cada página do Jamdesk.

Cada página do Jamdesk é um arquivo .mdx: Markdown padrão com componentes JSX como <Card>, <Tabs> e <Accordion>.

O que é MDX?

O MDX permite escrever Markdown padrão e incorporar componentes JSX no mesmo arquivo. Escreva títulos, listas e blocos de código em Markdown e, onde precisar de interatividade, insira componentes como <Card> ou <Tabs>.

MDX é texto simples que ferramentas de IA conseguem ler e escrever nativamente. Pode ser versionado no Git. Comporta componentes sem um formato proprietário.

# Welcome to My Docs

This is regular **Markdown** with a component below:

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

  Jump right in with our quickstart guide.

</Card>

O Validador MDX gratuito detecta erros de sintaxe antes de um build. O Formatador MDX gratuito corrige espaçamento e indentação. Cole uma página para verificá-la ou organizá-la sem executar a CLI.

Estrutura da página

Toda página MDX começa com o frontmatter, os metadados entre triplos traços:

---
title: My Page Title
description: A brief description for search and previews
---

Your content starts here...

O title e a description aparecem nos resultados de busca, nas abas do navegador e nas prévias em redes sociais.

Fundamentos do Markdown

Títulos

Use ## para seções principais e ### para subseções. O Jamdesk cria o sumário a partir dos seus títulos.

## Main Section
Content under the main section.

### Subsection
More detailed content here.

Comece com ## (h2) para o seu primeiro título. O título da página definido no frontmatter é o h1.

Formatação de texto

SintaxeResultado
**bold**bold
*italic*italic
~~strikethrough~~strikethrough
`inline code`inline code

Listas

Unordered list:
- First item
- Second item
  - Nested item

Ordered list:
1. First step
2. Second step
3. Third step

Citações em bloco

> This is a blockquote. Use it for callouts or
> highlighting important information.

This is a blockquote. Use it for callouts or highlighting important information.

Adicionando componentes

Componentes são elementos JSX que você pode usar em qualquer lugar do seu MDX. Eles podem ser autofechados ou envolver conteúdo:

{/* Self-closing component */}
<Card title="Example" icon="star" href="/introduction" />

{/* Component wrapping content */}
<Accordion title="Click to expand">

  This content is inside the accordion.

</Accordion>

Componentes disponíveis

O Jamdesk oferece estes componentes integrados:

Cards

Destaque recursos e crie navegação

Tabs

Organize o conteúdo em painéis alternáveis

Accordion

Seções recolhíveis para conteúdo opcional

Steps

Procedimentos numerados e tutoriais

Tabelas

Tabelas Markdown padrão funcionam sem configuração:

| Feature | Starter | Team |
|---------|------|-----|
| Pages | 10 | Unlimited |
| Custom domain | No | Yes |
FeatureStarterTeam
Pages10Unlimited
Custom domainNoYes

Use o componente Table para destacar linhas, alinhar células e mesclar colunas:

FeatureStarterTeam
Pages10Unlimited
Custom domainNoYes

Consulte Tabelas para a documentação completa do componente, incluindo destaque de linhas e células, mesclagem de colunas e opções de estilo.

Comentários

Adicione comentários que não aparecerão na saída renderizada:

{/* This is a comment - it won't be visible to readers */}

O que vem a seguir?

Otimização para SEO

Melhore a descoberta e os metadados

Frontmatter

Defina títulos, descrições e campos de SEO