Links e navegação
Conecte páginas, aponte para títulos específicos com âncoras e referencie URLs externas. Inclui navegação por Cards e verificação de links quebrados.
O MDX aceita links Markdown padrão. O Jamdesk acrescenta padrões para links de páginas, âncoras de títulos e URLs externas.
Links internos
Crie links para outras páginas da sua documentação usando caminhos relativos:
Read the [getting started guide](/quickstart) first.
See the [Card component](/components/card) for more options.
Use caminhos relativos à raiz da sua documentação, sem a extensão .mdx.
Link para títulos
Faça um link direto para uma seção usando âncoras:
See [configuration options](/config/docs-json-reference#colors)
Os títulos geram automaticamente âncoras a partir do seu texto:
## Getting Started→#getting-started## API Reference→#api-reference
Links externos
Crie links para sites externos:
Check the [GitHub repository](https://github.com/example/repo).
Links externos abrem em uma nova aba com configurações seguras.
Links com Cards
Use Cards em vez de links inline para uma navegação de destaque:
<Card title="Quickstart" icon="rocket" href="/quickstart">
Get up and running in 5 minutes
</Card>
Grupos de Cards
Agrupe links relacionados:
<Columns cols={2}>
<Card title="Installation" icon="download" href="/cli/overview">
Install the CLI
</Card>
<Card title="Configuration" icon="gear" href="/config/docs-json-reference">
Configure your project
</Card>
</Columns>
Práticas recomendadas
Informe ao leitor para onde o link leva:
{/* Good */}
Learn more in our [authentication guide](/quickstart).
{/* Avoid */}
For more info, [click here](/quickstart).Aponte para a seção relevante mais específica:
{/* Good - links to specific section */}
Configure [OAuth settings](/quickstart#whats-next).
{/* Less helpful - links to entire page */}
See the [auth docs](/quickstart) for OAuth settings.Links quebrados frustram os leitores. Execute verificações de links com regularidade:
jamdesk broken-linksIsso analisa sua documentação e informa quaisquer links internos quebrados.
Verificar links quebrados
A CLI do Jamdesk pode procurar links quebrados:
jamdesk broken-links
Exemplo de saída:
docs/getting-started.mdx:15 - /docs/quikstart
Did you mean: /docs/quickstart
Found 1 broken link in 45 files.
Execute isso antes de publicar para detectar erros de digitação e referências desatualizadas.
Corrigir links quebrados automaticamente
jamdesk fix repara um link quebrado que tem um destino correto e inequívoco (uma âncora com erro de digitação ou desvio de âncora entre locales, em que uma página traduzida renomeou seus títulos):
jamdesk fix --dry-run # preview every planned fix, write nothing
jamdesk fix # apply after a y/N confirmation
Ele reescreve um link somente quando a âncora corrigida é um título real na página de destino. Qualquer caso ambíguo é deixado para revisão manual. Veja Corrigir links quebrados automaticamente.
Como os links internos são detectados
Links sem https:// são tratados como internos e validados contra as páginas da sua documentação. O validador verifica se a página de destino existe na navegação do seu docs.json.
Sites que usam hostAtDocs (documentação hospedada em um subcaminho como /docs) recebem o prefixo /docs nos links internos em tempo de execução. Escreva os caminhos relativos à raiz da sua documentação:
{/* Just write the docs path — auto-prefixed to /docs/config/docs-json-reference */}
See the [Reference](/config/docs-json-reference).
Links que não são da documentação (como páginas de marketing) devem usar URLs completas: https://example.com/pricing.
Qualquer link /caminho no conteúdo da sua documentação é tratado como link interno da documentação.
Renomear páginas
Renomear uma página quebra os links para ela. Atualize cada referência com a CLI:
jamdesk rename api/old-name.mdx api/new-name.mdx
Este comando:
- Renomeia o arquivo
- Atualiza a navegação do
docs.json - Corrige os links em todas as outras páginas
