Changelog
Atualizações de estabilidade do playground da API
- Pesquisa para encontrar um endpoint
- Indicar um endpoint obsoleto com uma tag
- Ocultar páginas de API geradas automaticamente da navegação
- Fazer upload de arquivos multipart ou form data
Saiba mais em documentação do playground da API.
npm i mint
Agora é possível usar npm i mint@latest -g
para atualizar seu CLI.
Editor Web 3.0
Usabilidade reformulada no editor WYSIWYG.
Grandes melhorias
- Pesquisa de nomes de arquivos usando o atalho ⌘ + P
- Páginas carregam 10x mais rápido
- Tempos de carregamento mais rápidos ao pesquisar uma branch
- Aba de opções de página para configurar layout, título e metadados para SEO
- Barra de ferramentas flutuante ao destacar texto
Correções adicionais
- Corrigida a margem superior para componentes de changelog
- Melhorada a confiabilidade do comportamento do clique direito
- Após clicar em publicar, você permanecerá na mesma página em vez de ser levado a um estado vazio
- Cores padronizadas nos ícones de arquivos
- Melhorada a confiabilidade após selecionar novas branches várias vezes seguidas
- Removido o modo Diff
- Mais consistência ao criar uma nova pasta a partir do menu suspenso
- Corrigido o problema de citações em bloco criando mais citações em bloco ao tentar desselecionar
Traduções com IA em beta
Traduza toda a sua documentação com IA. Saiba mais.
Exportação de documentos para PDF em beta
Exporte toda a sua documentação, um subdiretório ou uma única página como PDF.
Suporte a hooks do React
Traga interatividade para seus documentos. Todos os hooks padrão do React estão automaticamente disponíveis em seus arquivos MDX. Saiba mais.
Gerador de servidor MCP
Gere servidores MCP para que aplicações de IA possam interagir com seus documentos ou APIs. O conteúdo escrito é automaticamente gerado como um servidor MCP, e você pode gerar um servidor MCP a partir de sua especificação OpenAPI com um clique. Confira a documentação sobre como começar com MCP.
Melhorias
- Marque atualizações do changelog com tags para que os usuários finais possam filtrar as atualizações
- Sonnet-3.7 suportado para Chat de IA. Configure seu modelo preferido através do painel
- Altere o nome do seu deployment diretamente nas configurações do painel
Correções de bugs
- Imagens OG corrigidas
- Corrigida a inconsistência de estilo de ícones para âncoras sem container
- Melhorados detalhes de estilo da borda do painel para responsividade mobile-tablet-desktop
- Mostrar exemplos de código mesmo quando no modo simples para o playground da API
- Suporte ao atalho “command + k” para pesquisa no editor web
- Blocos de código dentro de callouts expandem para preencher a largura da área do callout
Novo esquema de configuração docs.json
Introduzimos um novo docs.json
esquema como substituto para mint.json
, para suportar melhor o versionamento multinível, compreensão visual mais fácil e terminologia mais consistente. Para mais informações sobre o que mudou, confira nosso blog.
Atualize de mint.json
para docs.json
com os seguintes passos:
- Certifique-se de que seu CLI está na versão mais recente
- No repositório de seus documentos, execute
- Exclua seu arquivo mint.json antigo e envie suas alterações
Verificações de CI
Faça lint automaticamente em seus documentos para encontrar links quebrados, descobrir problemas de ortografia e gramática, ou impor estilos de escrita com sua própria configuração Vale. Saiba mais em nossa documentação.
Suporte a .md para LLMs
Todas as páginas de documentação agora estão automaticamente disponíveis como arquivos Markdown simples—basta adicionar .md
à URL. Isso facilita a ingestão de páginas individuais da sua documentação por LLMs.
Mais Temas
Novos temas pré-construídos para modificar a aparência e sensação dos seus documentos. Configure através do seu arquivo docs.json.
Agora disponíveis:
- Maple
- Palm
- Willow
Outras melhorias
- Guia para Escrita Técnica:Melhores práticas para escrever documentação técnica, incluindo pesquisa de público, tipos de conteúdo e dicas de escrita.
- Componente dropdown: Organize a navegação com um menu suspenso, além de abas e âncoras.
- Corretor de sintaxe com IA: O editor web detectará se há um erro de análise e usará IA para sugerir correções.
Melhorias no Assistente de IA
- Nova interface com página de chat dedicada e prompts pré-preenchidos
- Melhorias de estabilidade, por exemplo, correções de bugs de edição do arquivo errado ou nenhum arquivo
- Conhecimento mais robusto para adicionar e editar componentes
- Edição aprimorada do arquivo mint.json
Autenticação Parcial
Personalize o acesso a qualquer página ou seção de conteúdo dependendo das permissões do usuário. Suporta conexão com seu próprio sistema de autenticação.
Playground da API Reformulado
Reformulamos o design e o desempenho do Playground da API. As atualizações incluem:
- Expansão de detalhes mais fácil para uma visão geral de um campo
- Design aninhado mais intuitivo, por exemplo, adição ou exclusão de itens
- Tempos de resposta mais rápidos
Melhorias de Qualidade
- Suporte para exigir autenticação para acessar deployments de preview
Autenticação
Torne os documentos privados configurando a autenticação via JWT, OAuth ou uma senha universal. Com essa privacidade, você pode criar uma base de conhecimento interna ou impedir que concorrentes vejam seus documentos.
Assistente de IA
Agora você pode pedir à IA para fazer alterações em seus documentos, com o contexto de toda a documentação existente. Digite um prompt e o assistente proporá mudanças gerando um pull request.
Atualização da Integração com GitLab
Melhoramos nosso suporte para sincronização com o GitLab, como habilitar atualizações automatizadas e deployments de preview. Confira nossa documentação sobre GitLab para começar.
Editor Web
Reformulamos nosso editor web para que agora você possa atualizar documentos com uma experiência totalmente WYSIWYG, enquanto sincroniza com markdown.
Confira nossadocumentação sobre como começar com o Editor Web.
/llms.txt support
Todas as instâncias de documentação agora são automaticamente hospedadas em /llms.txt e /llms-full.txt para que os LLMs possam facilmente ingerir sua documentação. Para mais informações, leia adocumentação sobre o novo padrão llms.txt.
Localização
Agora você pode localizar seus documentos, o que funciona de forma semelhante ao versionamento. Adicione umlocale
a uma versão e o conteúdo fixo no Mintlify, como “Esta página foi útil?”, também corresponderá ao idioma.
Melhorias de Qualidade
- Retorne resultados de chat e pesquisa com base na versão atual que o usuário está lendo
- Autentique usuários com OAuth, além de tokens JWT ou Shared Session.
Changelogs
Lançamos um novoUpdate componentpara facilitar a exibição e o relato de atualizações (como esta) para seus usuários.
Destaque de Linhas de Código
Agora você pode destacar linhas de código em seus documentos para enfatizar e chamar a atenção para partes importantes adicionando um comentário especial após o identificador de linguagem. Use chaves{}
e especifique números de linha ou intervalos separados por vírgulas.
Blocos de código em modo claro
Os blocos de código agora têm uma variante de modo claro que pode ser ativada adicionando o seguinte ao seumint.json
:
Rodapé Avançado
Agora você pode adicionar mais links ao rodapé padrão. Esta atualização fornece mais consistência entre as páginas de destino e a documentação, ou maior personalização se você quiser destacar páginas específicas como redes sociais ou logs de status.
Filtrar pesquisa com base no usuário atual
Quando a personalização está ativada, os resultados da pesquisa agora são filtrados com base no usuário atualmente logado, para que eles vejam apenas o conteúdo relevante.
Prompts Personalizados para Chat de IA
Agora você pode personalizar os prompts para o chat de IA. Por favor, entre em contato com osupportse você quiser personalizar os prompts.
Melhorias no Painel
- Adicionada a capacidade de alterar o domínio personalizado para ser /docs diretamente através das configurações do painel.
- Consolidadas as páginas de login e cadastro para diminuir a fricção e confusão.
- Implementado o fluxo de login de descoberta para que usuários que são membros de várias organizações agora possam alternar entre elas.
- Adicionado login com Google OAuth
- Adicionada a capacidade de adicionar nova implantação através das configurações do painel.
Correções de Bugs
- Agora é possível usar barras iniciais na navegação.
- Agora é possível editar arquivos CSS e JS no editor web.
- Corrigido
suggestEdit
não aparecendo mesmo quando ativado. - Corrigida a navegação por teclado para Pesquisa e Chat, de modo que agora você pode usar as teclas de seta para cima e para baixo para navegar pelos resultados.
- Não permitir que motores de busca rastreiem páginas protegidas por autenticação de usuário.
- Revalidar o cache quando uma organização é excluída.
- Agora usamos o analisador Scalar OpenAPI para analisar definições OpenAPI, o que melhora o desempenho, corrige problemas de análise e apresenta melhores mensagens de erro.
- Descrições de nível superior agora são suportadas em páginas de referência de API geradas automaticamente a partir de definições OpenAPI.
- Adicionado suporte para estilo em linha para ícones
- Corrigido o pop-in de CSS personalizado nos documentos.
- Exibição adequada de estilo de código em linha em conjunto com links.
- Manter a posição de rolagem ao clicar no botão de voltar no navegador.
Fontes Personalizadas
Personalize a fonte de seus documentos com sua própria fonte hospedada em um CDN ou escolhendo entre as fontes do Google para combinar seus documentos com sua marca.
Imagens em componentes Card
Adicione uma propriedadeimg
a um card para exibir uma imagem no topo do card. Saiba mais sobre issoaqui.
Melhorias de Velocidade de Atualização
Para projetos grandes (~3.000 arquivos), a etapa de download para atualizações de documentos agora é ~440x mais rápida - uma redução de 99,8% no tempo. Em geral, os downloads de arquivos durante as atualizações agora são ~5,5x mais rápidos - uma redução de 81,8% no tempo.
Melhorias de SEO
Corrigimos o layout móvel e desktop de nossos documentos para que sejam mais amigáveis para SEO - incluindo a adição de tags aria adequadas aos elementos de navegação e alternância.
Melhorias no Painel
- Migração do roteador de aplicativos no painel.
- Análises de pesquisa agora estão disponíveis no painel.
- Funcionalidade de exclusão de organização foi adicionada ao painel.
- Interface de conexão com GitLab implementada.
- Correção de dados analíticos incorretos.
- Add-ons agora podem ser comprados diretamente através do painel.
Correções de Bugs
- Corrigido um bug onde a barra superior não se estendia à largura da tela quando estava no modo personalizado e o layout da barra lateral era
sidenav
. - Correção do posicionamento relativo do widget de IA.
Mais
- Solução de problemas para páginas de API: As páginas de API podem ser complicadas, então listamos problemas comuns para ajudar você a resolvê-los rapidamente —Leia a documentação
Páginas de Referência OpenAPI
- Endpoints definidos por OpenAPI que são complexos e recursivos agora são 98% menores.
- Agora mostramosadditionalPropertiesnas páginas OpenAPI.
Uploads de Arquivos no Playground da API
Por padrão, as solicitações do playground da API são intermediadas pelo Mintlify. Agora você pode usardisableProxy
para desativar esse comportamento e suportar tipos de solicitação como uploads de arquivos.
Melhorias de SEO para dispositivos móveis
Corrigimos o layout móvel de nossos documentos para que sejam mais amigáveis para SEO - incluindo a adição de tags aria adequadas aos elementos.
Formulário de Suporte
Adicionamos um formulário de suporte mais detalhado ao painel do Mintlify. Agora você pode enviar um formulário para entrar em contato conosco.
Correções de Bugs
- Corrigido um bug na funcionalidade de integração do Segment.
- Agora apresentamos mensagens de erro mais detalhadas para permissões do GitHub ao interagir com o editor.
- Corrigidos bugs onde a navegação não expandia corretamente quando um link direto era usado.
Widget de IA
ParaPro
usuários, introduzimos o Mintlify Widget, uma extensão de sua documentação para
responder às perguntas de seus usuários quando e onde eles perguntarem. Você pode adicionar este
chatbot alimentado por IA a qualquer página da web: sua página inicial, dentro do seu produto, ou
em suas páginas de documentação existentes.
Pro Plan
Também atualizamos nossos planos de preços para melhor personalização e escala.
Sincronização de Exemplo de Código do API Playground
Quando você navega pela documentação da API, o exemplo de código selecionado agora sincroniza entre suas páginas.
Insights
Atualmente em beta, este recurso resume perguntas e padrões comuns dos usuários em relatórios fáceis de digerir com sugestões alimentadas por IA sobre como melhorar seu produto.
Destaques da Semana de Lançamento
- Themes: Customize your styling with pre-configured themes. Just add the theme Quill, Prism, or Venus to your
mint.json
arquivo e ele atualizará o estilo da sua documentação. - Busca V2: consulte diretamente descrições e títulos de endpoints OpenAPI para acessar páginas de Referência de API, remova páginas ocultas da busca e aproveite nossa interface de barra de busca atualizada.
- Ramificação do Editor Web: crie branches em nosso editor web sem uma IDE.
- Personalização do Usuário: autentique usuários com Sessão Compartilhada ou JWT para que você possa mostrar conteúdo personalizado, como pré-preenchimento de chaves de API ou exibição de conteúdo específico para clientes.
- Atualizações de Automação OpenAPI: para preencher automaticamente páginas do API Playground, você pode adicionar um
openapi
campo a um objeto nos arrays de tabs ou anchors no mint.json.
Modo personalizado
Adicione uma configuração aos metadados para remover todos os elementos, exceto a barra superior. Exemplos de casos de uso:
- Crie uma configuração de página inicial global personalizada com componentes personalizados
- Adicione vídeos em tela cheia ou galerias de imagens
- Incorpore elementos de demonstração iFrame personalizados para adicionar interatividade à sua documentação
Confira nossadocumentação do Modo Personalizado.
Mintlify MDX para VSCode
Chame trechos de nossos componentes e callouts pré-construídos sem sair do VSCode.Instale a extensão aqui.
Melhorias de Qualidade
- Atualizações do painel: visualize logs de atualização para ver o que mudou e o status de uma atualização, alterne entre projetos Mintlify para gerenciar implantações
- Versionamento com abas totalmente suportado
- Redirecionamentos com curinga agora suportados
- Detecção de Erros CLI: agora mostramos a posição de frontmatter inválido quando há problemas de análise durante o desenvolvimento local
Destaques da Semana de Lançamento
- Implantações de Visualização: Quando você cria um pull request, geramos um link único que mostra uma prévia ao vivo de como sua documentação ficará em produção. Você pode compartilhar este link com colegas de equipe.
- Snippets V2: Agora suportamos componentes totalmente reutilizáveis e variáveis para snippets.
- Motor MDX de código aberto: Expusemos duas APIs—getCompiledMdx e MDXComponent—para que você possa acessar o markdown do Mintlify e o realce de sintaxe de código.Contribuições para o projetosão bem-vindas.
- Insights do Chat IA: Segmente o histórico de chat por data e aumente a cota de Chat IA do painel, e veja com que frequência uma consulta específica aparece.