Configurações Globais

Todo site Mintlify precisa de um arquivo docs.json com as configurações principais. Saiba mais sobre as propriedades abaixo.

Propriedades

namestringrequired

Nome do seu projeto. Usado para o título global.

Exemplo: mintlify

navigationNavigation[]required

Um array de grupos com todas as páginas dentro de cada grupo

Navigation

groupstring

O nome do grupo.

Exemplo: Settings

pagesstring[]

Os caminhos relativos aos arquivos markdown que servirão como páginas.

Exemplo: ["customization", "page"]

logostring or object

Caminho para a imagem do logo ou objeto com caminhos para logos nos modos "light" e "dark"

Logo

lightstring

Caminho para o logo no modo claro

darkstring

Caminho para o logo no modo escuro

hrefstring

Para onde o clique no logo redireciona

faviconstring

Caminho para a imagem do favicon

colorsColors

Códigos de cores hex para o seu tema global

Colors

primarystringrequired

A cor primária. Usada com mais frequência para conteúdo destacado, cabeçalhos de seção, acentos, no modo claro

lightstring

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

darkstring

A cor primária para botões importantes

backgroundobject

A cor de fundo nos modos claro e escuro

Object

lightstringrequired

O código de cor hexadecimal do fundo no modo claro

darkstringrequired

O código de cor hexadecimal do fundo no modo escuro

topbarLinksTopbarLink[]

Array de names e urls dos links que você deseja incluir na barra superior

TopbarLink

namestring

O nome do botão.

Exemplo: Contact us

urlstring

A URL ao clicar no botão. Exemplo: https://mintlify.com/docs

topbarCtaButtonCall to Action

Topbar Call to Action

type"link" or "github"

Link mostra um botão. GitHub mostra as informações do repositório na URL fornecida, incluindo o número de estrelas no GitHub.

urlstring

Se link: Para onde o botão redireciona.

Se github: Link para o repositório de onde carregar as informações do GitHub.

namestring

Texto dentro do botão. Só é necessário se o type for link.

versionsstring[]

Array de nomes de versões. Use isso apenas se quiser mostrar diferentes versões de documentação com um menu suspenso na barra de navegação.

anchorsAnchor[]

Um array de âncoras, incluindo icon, color e url.

Anchor

iconstring

O ícone do Font Awesome usado para destacar a âncora.

Exemplo: comments

namestring

O nome do rótulo da âncora.

Exemplo: Community

urlstring

O início da URL que marca quais páginas ficam na âncora. Geralmente, este é o nome da pasta onde você coloca suas páginas.

colorstring

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.

versionstring

Usado se quiser ocultar uma âncora até que a versão correta da documentação seja selecionada.

isDefaultHiddenboolean

Passe true se quiser ocultar a âncora até que você vincule diretamente alguém à documentação dentro dela.

iconTypestring

Um dos: "brands", "duotone", "light", "sharp-solid", "solid" ou "thin"

topAnchorObject

Substitua as configurações padrão para a âncora superior.

Object

namestring

O nome da âncora superior

iconstring

Ícone do Font Awesome.

iconTypestring

Um dos: "brands", "duotone", "light", "sharp-solid", "solid" ou "thin"

tabsTabs[]

Um array de abas de navegação.

Tabs

namestring

O nome do rótulo da aba.

urlstring

O início da URL que marca quais páginas ficam na aba. Geralmente, este é o nome da pasta onde você coloca suas páginas.

apiAPI

Configurações da API. Saiba mais sobre páginas de API em Componentes de API.

API

baseUrlstring

A URL base para todos os endpoints de API. Se baseUrl for um array, ele habilitará múltiplas opções de URL base que o usuário poderá alternar.

authAuth

Auth

method"bearer" | "basic" | "key"

A estratégia de autenticação usada para todos os endpoints de API.

namestring

O nome do parâmetro de autenticação usado no playground de API.

Se o método for basic, o formato deve ser [usernameName]:[passwordName]

inputPrefixstring

O valor padrão que serve como prefixo para o campo de entrada de autenticação.

Ex.: Se um inputPrefix de AuthKey seria herdar o resultado de entrada padrão do campo de autenticação como AuthKey.

playgroundPlayground

Configurações do playground de API

Playground

mode"show" | "simple" | "hide"

Se o playground está visível, oculto ou exibindo apenas o endpoint sem interatividade adicional do usuário simple

Saiba mais nos guias do playground

maintainOrderboolean

Habilitar esta flag garante que a ordenação de chaves nas páginas OpenAPI corresponda à ordenação de chaves definida no arquivo OpenAPI.

aviso

Este comportamento será habilitado por padrão em breve, momento em que este campo será descontinuado.

openapistring | string[]

Uma string ou um array de strings de URL(s) ou caminho(s) apontando para seu arquivo OpenAPI.

Exemplos:

"openapi": "https://example.com/openapi.json"

"openapi": "/openapi.json"

"openapi": ["https://example.com/openapi1.json", "/openapi2.json", "/openapi3.json"]

footerSocialsFooterSocials

Um objeto de contas de redes sociais onde o par chave:propriedade representa a plataforma de rede social e a URL da conta.

Exemplo:

{
  "x": "https://x.com/mintlify",
  "website": "https://mintlify.com"
}

FooterSocials

[key]string

Um dos seguintes valores: website, facebook, x, discord, slack, github, linkedin, instagram, hacker-news

Exemplo: x

propertystring

A URL da plataforma social.

Exemplo: https://x.com/mintlify

feedbackFeedback

Configurações para habilitar botões de feedback

Feedback

suggestEditboolean

Habilita um botão para permitir que os usuários sugiram edições via pull requests

raiseIssueboolean

Habilita um botão para permitir que os usuários abram uma issue sobre a documentação

modeToggleModeToggle

Personalize a alternância de modo escuro.

ModeToggle

default"light" or "dark"

Defina se você sempre quer mostrar o modo claro ou escuro para novos usuários. Quando não definido, usamos o mesmo modo do sistema operacional do usuário.

isHiddenboolean

Defina como true para ocultar a alternância de modo escuro/claro. Você pode combinar isHidden com default para forçar sua documentação a usar apenas o modo claro ou escuro. Por exemplo:

"modeToggle": {
  "default": "dark",
  "isHidden": true
}

"modeToggle": {
  "default": "light",
  "isHidden": true
}

backgroundImagestring

Uma imagem de fundo para ser exibida atrás de cada página. Veja exemplos com Infisical e FRPC.