Todo site Mintlify precisa de um arquivo docs.json com as configurações principais. Saiba mais sobre as propriedades abaixo.
Propriedades
Nome do projeto. Usado como título global.Exemplo: mintlify
Lista de grupos com as páginas de cada grupo
Nome do grupo.Exemplo: Settings
Caminhos relativos aos arquivos markdown que serão páginas.Exemplo: ["customization", "page"]
Caminho do logo ou objeto com caminhos para modo claro e escuro
Caminho do logo no modo claro
Caminho do logo no modo escuro
Destino ao clicar no logo
Cores hex do tema global
Cor primária: conteúdo em destaque, cabeçalhos de seção, acentos no modo claro
Cor primária no modo escuro: conteúdo em destaque, cabeçalhos, acentos
Cor primária para botões importantes
Cor de fundo nos modos claro e escuro
Código hex do fundo no modo claro
Código hex do fundo no modo escuro
Lista de name e url dos links na barra superior
Texto do botão.Exemplo: Contact us
URL ao clicar. Exemplo: https://mintlify.com/docs
Show Topbar Call to Action
type
"link" or "github"
default:"link"
Com link exibe um botão. Com github exibe informações do repositório e estrelas.
Se for link: destino do botão.Se for github: URL do repositório para carregar dados do GitHub.
Texto do botão. Obrigatório apenas se type for link.
Nomes de versão. Use apenas se quiser várias versões da documentação com seletor na barra de navegação.
Lista de âncoras com icon, color e url.
Rótulo da âncora.Exemplo: Community
Prefixo de URL das páginas desta âncora. Geralmente coincide com o nome da pasta de páginas.
Cor hex do fundo do ícone. Também pode ser um gradiente com from e to em hex.
Use se quiser ocultar a âncora até que a versão correta da documentação seja selecionada.
true para ocultar a âncora até que alguém link diretamente para documentação dentro dela.
Um de: “brands”, “duotone”, “light”, “sharp-solid”, “solid” ou “thin”
Substitui a configuração da âncora superior.
name
string
default:"Documentation"
Nome da âncora superior
icon
string
default:"book-open"
Ícone Font Awesome.
Um de: “brands”, “duotone”, “light”, “sharp-solid”, “solid” ou “thin”
Abas de navegação principais.
Prefixo de URL das páginas desta aba. Geralmente coincide com o nome da pasta.
Configuração da API. Mais informações em componentes de API.
URL base dos endpoints. Se baseUrl for um array, o usuário pode alternar entre várias bases.
method
"bearer" | "basic" | "key"
Estratégia de autenticação para todos os endpoints.
Nome do parâmetro de autenticação no playground.Se o método for basic, o formato deve ser [usuário]:[senha]
Prefixo padrão do campo de autenticação.Ex.: com inputPrefix AuthKey, o valor padrão do campo será AuthKey.
Opções do playground de API
mode
"show" | "simple" | "hide"
default:"show"
Se o playground está visível, oculto ou em modo simple (apenas o endpoint, sem interação).Mais nas guias do playground Garante que a ordem das chaves nas páginas OpenAPI corresponda ao arquivo OpenAPI.Em breve será o comportamento padrão e este campo será descontinuado.
String ou lista de URLs ou caminhos relativos ao arquivo OpenAPI.Exemplos:"openapi": "https://example.com/openapi.json"
Objeto de redes sociais: cada chave é a plataforma e o valor é a URL.Exemplo:{
"x": "https://x.com/mintlify",
"website": "https://mintlify.com"
}
Uma de: website, facebook, x, discord, slack, github, linkedin, instagram, hacker-newsExemplo: x
URL do perfil ou página.Exemplo: https://x.com/mintlify
Botões de feedback
Botão para sugerir edições via pull requests
Botão para abrir um issue sobre a documentação
Personalize o alternador claro/escuro.
Força modo claro ou escuro para novos usuários. Se não definido, usa a preferência do sistema.
true para ocultar o alternador. Combine com default para forçar apenas claro ou escuro. Por exemplo:"modeToggle": {
"default": "dark",
"isHidden": true
}
Imagem de fundo atrás de todas as páginas. Exemplos:
Infisical e FRPC. 
