Jamdesk Documentation logo

Escrita e organização

Tudo sobre criar páginas no Jamdesk: sintaxe MDX, blocos de código, mídia incorporada, SEO e ferramentas para visualizar seu trabalho antes da publicação.

As páginas do Jamdesk são arquivos MDX: Markdown padrão com componentes React disponíveis sempre que você precisar deles. Uma página é apenas frontmatter e conteúdo.

---
title: Rate Limits
description: How rate limiting works across API tiers.
---

Requests are limited per API key.

<Note>Enterprise plans have custom limits.</Note>

A maior parte do que você escreverá será Markdown simples. As páginas desta seção abordam o restante: blocos de código com destaque de sintaxe, imagens e vídeos, notação matemática, snippets reutilizáveis e os campos de frontmatter que controlam títulos, ícones e metadados de SEO.

MDX e páginas

Noções básicas de MDX

Markdown com componentes React incorporados. Comece aqui.

Blocos de código

Destaque de sintaxe, números de linha, nomes de arquivo e CodeGroups

Componentes React personalizados

Defina seus próprios componentes com renderização no servidor e Tailwind

Frontmatter

Títulos, descrições, ícones, substituições da barra lateral e metadados de SEO

Cabeçalhos

Cabeçalhos H2 e H3 que preenchem o índice

Ícones

Ícones Font Awesome Pro em cards, chamadas, navegação e texto inline

Links e âncoras

Links internos, âncoras de cabeçalho e URLs externas

Math e LaTeX

Renderização KaTeX para equações e expressões

SEO

Meta tags, prévias para redes sociais e sitemaps gerados automaticamente

Páginas ocultas

Mantenha páginas fora da barra lateral e da pesquisa sem excluí-las

Snippets

Blocos de conteúdo reutilizáveis que você importa entre páginas

Mídia e incorporações

Imagens

Dimensionamento, legendas, variantes claras/escuras e formatos compatíveis

YouTube

Vídeos e Shorts carregados sob demanda com tempos de início personalizados

Vídeos

MP4 e WebM com propriedades de reprodução automática, loop e pôster

iFrames

Vimeo, CodePen, Figma, Loom e outras incorporações externas

Ferramentas de criação

Você não precisa fazer push para ver suas alterações. Visualize localmente com a CLI, edite no navegador ou controle o servidor de desenvolvimento pelo VS Code.

Prévia local

Execute sua documentação na máquina com recarregamentos instantâneos

Editor web

Edite MDX no navegador com prévia ao vivo e faça commit diretamente no repositório

Extensão do VS Code

Inicie e pare o servidor de desenvolvimento pela barra de status