Todo site de documentação requer umdocs.json arquivo.
Este arquivo contém as configurações globais e controla tudo, desde estilização e navegação até integrações.
Referência Esta seção contém a referência completa para o arquivo docs.json.
Personalização Um dos seguintes:mint,maple,palm,willow,linden,almond.
O tema de layout do projeto. Confira a páginaThemes para mais informações.
O nome do projeto, organização ou produto
As cores a serem usadas em sua documentação. No mínimo, você deve definir a cor primária. Por exemplo:
{ "colors" : { "primary" : "#ff0000" } } primary
string matching ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$
required
A cor primária do tema
Deve ser um código hexadecimal começando com#
light
string matching ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$
A cor clara do tema. Usada para o modo escuro
Deve ser um código hexadecimal começando com#
dark
string matching ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$
A cor escura do tema. Usada para o modo claro
Deve ser um código hexadecimal começando com#
Descrição opcional usada para SEO e indexação de LLM
O logotipo (para ambos os modos claro e escuro)
Caminho apontando para o arquivo de logotipo claro a ser usado no modo escuro, incluindo a extensão do arquivo. Exemplo:/logo.png
Caminho apontando para o arquivo de logotipo escuro a ser usado no modo claro, incluindo a extensão do arquivo. Exemplo:/logo-dark.png
A URL para redirecionar ao clicar no logotipo. Se não fornecido, o logotipo irá linkar para a página inicial. Exemplo:https://example.com
O caminho para o seu arquivo de favicon na pasta docs, incluindo a extensão do arquivo. O arquivo será automaticamente redimensionado para tamanhos apropriados de favicon.
Pode ser um único arquivo ou um par para os modos claro e escuro. Exemplo:/favicon.png
Caminho apontando para o arquivo de favicon claro a ser usado no modo escuro, incluindo a extensão do arquivo. Exemplo:/favicon.png
Caminho apontando para o arquivo de favicon escuro a ser usado no modo claro, incluindo a extensão do arquivo. Exemplo:/favicon-dark.png
Configurações de estilo
eyebrows
"section" | "breadcrumbs"
O estilo de sobrancelhas do conteúdo. O padrão ésection.
O tema do bloco de código. O padrão ésystem.
Configurações da biblioteca de ícones
library
"fontawesome" | "lucide"
required
A biblioteca de ícones a ser usada. O padrão éfontawesome.
A família da fonte, como “Open Sans”, “Playfair Display”
O peso da fonte, como 400, 700. Pesos de fonte precisos como 550 são suportados para fontes variáveis.
O formato da fonte, pode ser woff ou woff2
A família da fonte, como “Open Sans”, “Playfair Display”
O peso da fonte, como 400, 700. Pesos de fonte precisos como 550 são suportados para fontes variáveis.
O formato da fonte, pode ser woff ou woff2
A família da fonte, como “Open Sans”, “Playfair Display”
O peso da fonte, como 400, 700. Pesos de fonte precisos como 550 são suportados para fontes variáveis.
O formato da fonte, pode ser woff ou woff2
Configurações de alternância do modo claro / escuro
default
"system" | "light" | "dark"
O modo claro/escuro padrão. O padrão ésystem
Se deve ocultar a alternância do modo claro / escuro. O padrão étrue.
Configurações de cor de fundo e decoração
decoration
"gradient" | "grid" | "windows"
A decoração de fundo do tema
As cores do fundo
light
string matching ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$
A cor em formato hexadecimal a ser usada no modo claro
Deve corresponder ao padrão: ^#([a-fA-F0-9]|[a-fA-F0-9])$
dark
string matching ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$
A cor em formato hexadecimal a ser usada no modo escuro
Deve corresponder ao padrão: ^#([a-fA-F0-9]|[a-fA-F0-9])$
Structure Conteúdo e configurações da barra de navegação
Os links na barra de navegação
Um caminho válido ou link externo
type
"button" | "github"
required
O rótulo para o botão primário. Isso só se aplica quandotypeestá definido comobutton.
Um caminho válido ou link externo. Setypeestiver definido comogithub, esta será a URL para o repositório.
A estrutura de navegação do conteúdo
Adicione links externos que aparecerão em todas as seções e páginas, independentemente do aninhamento da navegação
language
"en" | "cn" | "zh" | "zh-Hans" | "zh-Hant" | "es" | "fr" | "ja" | "jp" | "pt" | "pt-BR" | "de" | "ko" | "it" | "ru" | "id" | "ar" | "tr"
required
O nome do idioma no formato ISO 639-1
Se este idioma é o idioma padrão
Se a opção atual está oculta por padrão
Um caminho válido ou link externo
O nome da versão
Comprimento mínimo: 1
Se esta versão é a versão padrão
Se a opção atual está oculta por padrão
O nome da aba
Comprimento mínimo: 1
O ícone a ser exibido na seção
Se a opção atual está oculta por padrão
O nome da âncora
Comprimento mínimo: 1
O ícone a ser exibido na seção
light
string matching ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$
A cor em formato hexadecimal a ser usada no modo claro
Deve corresponder ao padrão: ^#([a-fA-F0-9]|[a-fA-F0-9])$
dark
string matching ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$
A cor em formato hexadecimal a ser usada no modo escuro
Deve corresponder ao padrão: ^#([a-fA-F0-9]|[a-fA-F0-9])$
Se a opção atual está oculta por padrão
Um caminho válido ou link externo
O nome do dropdown
Comprimento mínimo: 1
O ícone a ser exibido na seção
Se a opção atual está oculta por padrão
pages
array of string or object
Configurações do rodapé
Um objeto no qual cada chave é o nome de uma plataforma de mídia social, e cada valor é a URL do seu perfil. Por exemplo:
{ "x" : "https://x.com/mintlify" } Nomes de propriedades válidos: x, website, facebook, youtube, discord, slack, github, linkedin, instagram, hacker-news, medium, telegram, twitter, x-twitter, earth-americas, bluesky, threads, reddit, podcast
Os links a serem exibidos no rodapé
O título do cabeçalho da coluna
Comprimento mínimo: 1
Os links a serem exibidos na coluna
O rótulo do link
Comprimento mínimo: 1
Configurações do banner
O conteúdo do banner. Isso pode ser uma string de texto ou uma string markdown. Por exemplo:
{ "content" : "🚀 Banner is live! [Learn more](mintlify.com)" } Se o banner é descartável. O padrão é false.
options
array of "copy" | "view" | "chatgpt" | "claude"
required
As opções a serem exibidas no menu contextual. A primeira opção é a opção padrão.
copy: Copiar a página atual como markdown para a área de transferênciaview: Visualizar a página atual como markdown em uma nova abachatgpt: Alimentar a página atual para o ChatGPTclaude: Alimentar a página atual para o Claude O menu contextual está disponível apenas em implantações de visualização e produção.
Configurações de API Configuração de referência de API e configurações do playground
openapi
string or array or object
Uma string ou uma matriz de strings de URLs absolutas ou relativas apontando para o(s) arquivo(s) OpenAPI
sem barra inicial no diretório
asyncapi
string or array or object
Uma string ou uma matriz de strings de URLs absolutas ou relativas apontando para o(s) arquivo(s) AsyncAPI
Configurações para o playground da API
display
"interactive" | "simple" | "none"
O modo de exibição do playground da API. O padrão é interactive.
Se deve passar as solicitações da API por um servidor proxy. O padrão é true.
Configurações para os exemplos de API gerados automaticamente
Linguagens de exemplo para os snippets de API gerados automaticamente
Se deve mostrar parâmetros opcionais nos exemplos de API, o padrão é all
Configurações para páginas de API geradas a partir de arquivos MDX
Configuração de autenticação para a API
method
"bearer" | "basic" | "key" | "cobo"
Método de autenticação para a API
Nome de autenticação para a API
SEO e Busca Configurações de indexação SEO
Meta tags adicionadas a cada página. Deve ser um par chave-valor válido. Opções possíveis aqui
Especifique quais páginas devem ser indexadas pelos mecanismos de busca. Definir navigable indexa páginas que estão definidas na navegação, all indexa todas as páginas. O padrão é navigable.
Configurações de exibição da busca
O prompt a ser exibido no placeholder da barra de busca
Integrações Configurações para integrações oficiais
measurementId
string matching ^G
required
Deve corresponder ao padrão: ^G
tagId
string matching ^G
required
Deve corresponder ao padrão: ^G
apiKey
string matching ^phc\_
required
Deve corresponder ao padrão: ^phc_
Erros Se deve redirecionar para a página inicial, caso a página não seja encontrada
Validação É aconselhável incluir a seguinte referência de esquema no topo do seu arquivo docs.json para garantir a validação adequada durante a edição:
{ "$schema" : "https://mintlify.com/docs.json" , ... } 
