Todo site Mintlify precisa de um arquivo docs.json com as configurações principais. Saiba mais sobre as propriedades abaixo.
Propriedades Nome do seu projeto. Usado para o título global. Exemplo: mintlify
Um array de grupos com todas as páginas dentro desse grupo O nome do grupo. Exemplo: Configurações
Os caminhos relativos para os arquivos markdown que servirão como páginas. Exemplo: ["customization", "page"]
Caminho para a imagem do logo ou objeto com caminho para imagens do logo em modo “light” e “dark” Caminho para o logo no modo claro
Caminho para o logo no modo escuro
Para onde clicar no logo te leva
Caminho para a imagem do favicon
Códigos de cor hexadecimal para o seu tema global A cor primária. Usada com mais frequência para conteúdo destacado, cabeçalhos
de seção, acentos, no modo claro
A cor primária para o modo escuro. Usada com mais frequência para conteúdo
destacado, cabeçalhos de seção, acentos, no modo escuro
A cor primária para botões importantes
A cor do fundo em ambos os modos claro e escuro O código de cor hexadecimal do fundo no modo claro
O código de cor hexadecimal do fundo no modo escuro
Array de names e urls de links que você deseja incluir na barra superior O nome do botão. Exemplo: Entre em contato
A url quando você clica no botão. Exemplo: https://mintlify.com/docs
Show Chamada para Ação da Barra Superior
type
"link" or "github"
default: "link"
Link mostra um botão. GitHub mostra as informações do repositório na url fornecida incluindo o número de estrelas do GitHub.
Se link: Para onde o botão leva. Se github: Link para o repositório para carregar informações do GitHub.
Texto dentro do botão. Apenas necessário se type for link.
Array de nomes de versões. Use apenas se quiser mostrar diferentes versões
de documentação com um menu suspenso na barra de navegação.
Um array das âncoras, inclui o icon, color e url. O ícone do Font Awesome usado para destacar a âncora. Exemplo: comments O nome do rótulo da âncora. Exemplo: Comunidade
O início da URL que marca quais páginas vão na âncora. Geralmente, este é o nome da pasta onde você coloca suas páginas.
A cor hexadecimal do fundo do ícone da âncora. Também pode ser um gradiente se você passar um objeto com as propriedades from e to que são cada uma uma cor hexadecimal.
Usado se você quiser ocultar uma âncora até que a versão correta da documentação seja selecionada.
Passe true se quiser ocultar a âncora até que você vincule diretamente alguém à documentação dentro dela.
Um de: “brands”, “duotone”, “light”, “sharp-solid”, “solid” ou “thin”
Substitui as configurações padrão para a âncora mais superior. name
string
default: "Documentação"
O nome da âncora mais superior
icon
string
default: "book-open"
Ícone do Font Awesome.
Um de: “brands”, “duotone”, “light”, “sharp-solid”, “solid” ou “thin”
Um array de abas de navegação. O início da URL que marca quais páginas vão na aba. Geralmente, este
é o nome da pasta onde você coloca suas páginas.
Configuração para configurações da API. Saiba mais sobre páginas de API em Componentes da API . A url base para todos os endpoints da API. Se baseUrl for um array, habilitará múltiplas opções
de url base que o usuário pode alternar.
method
"bearer" | "basic" | "key"
A estratégia de autenticação usada para todos os endpoints da API.
O nome do parâmetro de autenticação usado no playground da API. Se o método for basic, o formato deve ser [usernameName]:[passwordName]
O valor padrão que é projetado para ser um prefixo para o campo de entrada de autenticação. Ex. Se um inputPrefix de AuthKey herdaria o resultado de entrada padrão do campo de autenticação como AuthKey.
Configurações para o playground da API mode
"show" | "simple" | "hide"
default: "show"
Se o playground está mostrando, oculto ou apenas exibindo o endpoint sem interatividade adicional do usuário simple Saiba mais nos guias do playground Habilitar esta flag garante que a ordem das chaves nas páginas OpenAPI corresponda à ordem das chaves definida no arquivo OpenAPI. Este comportamento será habilitado por padrão em breve, momento em que este campo será depreciado.
Uma string ou um array de strings de URL(s) ou caminho(s) relativo(s) apontando para o seu
arquivo OpenAPI. Exemplos: Absoluto
Relativo
Múltiplos
"openapi" : "https://example.com/openapi.json"
Um objeto de contas de redes sociais onde o par chave:propriedade representa a plataforma de mídia social e a url da conta. Exemplo: { "x" : "https://x.com/mintlify" , "website" : "https://mintlify.com" }
Um dos seguintes valores website, facebook, x, discord, slack, github, linkedin, instagram, hacker-news Exemplo: x
A URL para a plataforma social. Exemplo: https://x.com/mintlify
Configurações para habilitar botões de feedback Habilita um botão para permitir que os usuários sugiram edições via pull requests
Habilita um botão para permitir que os usuários relatem um problema sobre a documentação
Personalize o alternador de modo escuro. Defina se você sempre quer mostrar modo claro ou escuro para novos usuários. Quando não
definido, usamos o mesmo modo do sistema operacional do usuário.
Defina como true para ocultar o alternador de modo escuro/claro. Você pode combinar isHidden com default para forçar sua documentação a usar apenas modo claro ou escuro. Por exemplo: Apenas Modo Escuro
Apenas Modo Claro
"modeToggle" : { "default" : "dark" , "isHidden" : true }
Uma imagem de fundo para ser exibida atrás de cada página. Veja exemplo com
Infisical e FRPC . 
