Suporte a monorepo
Configure o modo monorepo nas configurações do projeto Jamdesk informando o caminho do diretório da sua documentação para que o Jamdesk compile apenas ela e ignore o restante
Se o seu docs.json estiver em um subdiretório (docs/, packages/docs/ ou qualquer outro), ative o modo monorepo nas configurações do projeto e informe o caminho. O Jamdesk compila apenas esse diretório.
As capturas de tela mostram a interface em inglês.
Pré-requisitos: Você precisa de um projeto Jamdesk conectado a um repositório GitHub antes de configurar o suporte a monorepo.
Como o Jamdesk limita seu build
Configuração rápida
Abra o seu projeto no painel Jamdesk e acesse Settings.
Na seção Git Repository, ative Set up as monorepo.

Informe o caminho do diretório que contém o seu arquivo docs.json.

A pré-visualização mostra onde o Jamdesk procura o seu arquivo de configuração.
Clique em Save Changes. A sua próxima compilação usa o novo caminho.
Entenda o caminho da documentação
Informe apenas o caminho do diretório, não o nome do arquivo. Use docs, não docs/docs.json.
Exemplos de caminhos
| Estrutura do repositório | Valor do caminho da documentação |
|---|---|
my-repo/docs/docs.json | docs |
my-repo/packages/docs/docs.json | packages/docs |
my-repo/apps/website/docs/docs.json | apps/website/docs |
my-repo/documentation/docs.json | documentation |
O que é incluído
O Jamdesk processa apenas os arquivos dentro do caminho da documentação:
- Arquivos de conteúdo (
.mdx,.md) são compilados em páginas - Recursos em subdiretórios (como
images/) são incluídos - Configuração (
docs.json) define o seu site
Arquivos fora do caminho da documentação são ignorados durante as compilações.
Padrões comuns de monorepo
Documentação em um diretório de nível superior.
monorepo/
├── packages/
├── apps/
└── docs/ # Docs path: docs
├── docs.json
├── introduction.mdx
└── guides/Caminho da documentação: docs
Trabalhando com assets
Os caminhos de recursos no docs.json são sempre relativos ao diretório da sua documentação, não à raiz do repositório.
Exemplo
Para a documentação em packages/docs/:
{
"logo": {
"light": "/images/logo.svg"
},
"favicon": "/images/favicon.svg"
}Esses caminhos referenciam:
packages/docs/images/logo.svgpackages/docs/images/favicon.svg
Não use caminhos absolutos a partir da raiz do repositório. Isto falha:
"favicon": "/packages/docs/images/favicon.svg"Em arquivos MDX
As imagens em MDX seguem a mesma regra:

Isso referencia uma imagem em [caminho-da-documentação]/images/tabs-preview.png.
Links internos
Os links internos não dependem da estrutura do seu repositório. Use caminhos relativos à raiz da sua documentação:
[See the quickstart guide](/quickstart)
[Installation steps](/quickstart#installation)
Esses caminhos correspondem à estrutura de navegação, não ao seu sistema de arquivos.
Comportamento dos builds
Apenas alterações dentro do caminho da documentação disparam uma compilação:
- Alterações em
packages/docs/**disparam uma compilação - Alterações em
packages/core/**não disparam uma compilação
Precisa recompilar quando outro código muda?
Para documentação gerada a partir do código-fonte (como a documentação de API a partir de comentários no código), dispare uma recompilação manual pelo painel ou configure um webhook no seu pipeline de CI.
Compatibilidade com ferramentas de workspace
Defina o caminho da documentação. Nenhuma outra configuração é necessária para estas ferramentas de monorepo.
| Ferramenta | Suportada |
|---|---|
| npm workspaces | Sim |
| Yarn workspaces | Sim |
| pnpm workspaces | Sim |
| Turborepo | Sim |
| Nx | Sim |
| Lerna | Sim |
Solução de problemas
- Verifique se o caminho exato no seu repositório corresponde ao que você informou
- Confirme que
docs.jsonexiste nesse local - Verifique erros de digitação. Os caminhos diferenciam maiúsculas de minúsculas
- Lembre-se: use
docs, nãodocs/docs.json
Verificação rápida: no seu repositório, o arquivo deve existir em [seu-caminho-da-documentação]/docs.json
Os caminhos de recursos devem ser relativos ao diretório da sua documentação.
Correto (relativo ao diretório da documentação):
"favicon": "/images/favicon.svg"Errado (absoluto a partir da raiz do repositório):
"favicon": "/packages/docs/images/favicon.svg"Verifique se as suas imagens existem em [caminho-da-documentação]/images/.
Apenas alterações dentro do caminho da documentação disparam compilações automáticas.
- Verifique se você está modificando arquivos dentro do caminho da documentação
- Confirme que você está enviando para o branch correto
- Veja o status das entregas de webhook nas configurações do repositório no GitHub
Para compilar com alterações fora do caminho da documentação, use recompilações manuais ou webhooks de CI.
