Jamdesk Documentation logo

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

1
Abra as configurações do projeto

Abra o seu projeto no painel Jamdesk e acesse Settings.

2
Ative o modo monorepo

Na seção Git Repository, ative Set up as monorepo.

Monorepo toggle in project settings
3
Informe o caminho da documentação

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

Docs path input showing preview

A pré-visualização mostra onde o Jamdesk procura o seu arquivo de configuração.

4
Salve e recompile

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órioValor do caminho da documentação
my-repo/docs/docs.jsondocs
my-repo/packages/docs/docs.jsonpackages/docs
my-repo/apps/website/docs/docs.jsonapps/website/docs
my-repo/documentation/docs.jsondocumentation

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/:

packages/docs/docs.json
{
  "logo": {
    "light": "/images/logo.svg"
  },
  "favicon": "/images/favicon.svg"
}

Esses caminhos referenciam:

  • packages/docs/images/logo.svg
  • packages/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:

![Screenshot](/images/tabs-preview.png)

Isso referencia uma imagem em [caminho-da-documentação]/images/tabs-preview.png.

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.

FerramentaSuportada
npm workspacesSim
Yarn workspacesSim
pnpm workspacesSim
TurborepoSim
NxSim
LernaSim

Solução de problemas

  1. Verifique se o caminho exato no seu repositório corresponde ao que você informou
  2. Confirme que docs.json existe nesse local
  3. Verifique erros de digitação. Os caminhos diferenciam maiúsculas de minúsculas
  4. Lembre-se: use docs, não docs/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.

  1. Verifique se você está modificando arquivos dentro do caminho da documentação
  2. Confirme que você está enviando para o branch correto
  3. 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.

O que vem a seguir?

Conectar GitHub

Vincule o seu repositório para compilações automáticas

Estrutura de diretórios

Organize a sua documentação para escalar