diff --git a/docs.json b/docs.json index 44a64f824..336c7c460 100644 --- a/docs.json +++ b/docs.json @@ -1,296 +1,463 @@ { - "$schema": "https://mintlify.com/docs.json", "theme": "maple", + "$schema": "https://mintlify.com/docs.json", "name": "Mintlify", "colors": { "primary": "#0D9373", "light": "#55D799", "dark": "#0D9373" }, + "logo": { + "light": "/logo/light.svg", + "dark": "/logo/dark.svg", + "href": "https://mintlify.com" + }, "favicon": "/favicon.svg", + "api": { + "mdx": { + "auth": { + "method": "bearer" + } + } + }, + "navbar": { + "links": [ + { + "label": "Community", + "href": "https://mintlify.com/community" + } + ], + "primary": { + "type": "button", + "label": "Get Started", + "href": "https://mintlify.com/start" + } + }, "navigation": { - "dropdowns": [ + "languages": [ { - "dropdown": "Getting Started", - "icon": "book", - "description": "Set up your documentation", - "groups": [ + "language": "en", + "dropdowns": [ { - "group": "Getting Started", - "pages": [ - "quickstart", - { - "group": "Editing", - "icon": "pen-paintbrush", - "pages": ["development", "web-editor"] - }, - "settings/global", + "dropdown": "Getting Started", + "icon": "book", + "description": "Set up your documentation", + "groups": [ { - "group": "Navigation", - "icon": "map", + "group": "Getting Started", "pages": [ - "navigation/overview", - "navigation/pages", - "navigation/divisions", - "navigation/versions", - "navigation/localization" - ] - }, - "themes", - "migration" - ] - }, - { - "group": "Writing Content", - "pages": [ - "page", - "text", - "image-embeds", - "list-table", - "code", - "reusable-snippets" - ] - }, - { - "group": "API References", - "pages": [ - "api-playground/overview", - { - "group": "OpenAPI", - "icon": "brackets-curly", - "pages": [ - "api-playground/openapi/setup", - "api-playground/openapi/writing-openapi", - "api-playground/openapi/advanced-features" - ] - }, - { - "group": "MDX", - "icon": "markdown", - "pages": [ - "api-playground/mdx/configuration", - "api-playground/mdx/authentication" + "quickstart", + { + "group": "Editing", + "icon": "pen-paintbrush", + "pages": [ + "development", + "web-editor" + ] + }, + "settings/global", + { + "group": "Navigation", + "icon": "map", + "pages": [ + "navigation/overview", + "navigation/pages", + "navigation/divisions", + "navigation/versions", + "navigation/localization" + ] + }, + "themes", + "migration" ] }, - "api-playground/troubleshooting" - ] - }, - { - "group": "Configurations", - "pages": [ - "settings/custom-domain", - "settings/seo", - "settings/llms", - "settings/custom-scripts", - "settings/broken-links", - "settings/github", - "settings/gitlab", - "settings/ci", - "settings/preview-deployments" - ] - }, - { - "group": "Advanced", - "pages": [ { - "group": "Custom Subdirectory", - "icon": "folder", + "group": "Writing Content", "pages": [ - "advanced/subpath/cloudflare", - "advanced/subpath/route53-cloudfront", - "advanced/subpath/vercel" + "page", + "text", + "image-embeds", + "list-table", + "code", + "reusable-snippets" ] }, { - "group": "Auth & Personalization", - "icon": "user-lock", + "group": "API References", "pages": [ - "settings/authentication-personalization/authentication", - "settings/authentication-personalization/partial-authentication", - "settings/authentication-personalization/personalization", - "settings/authentication-personalization/authentication-vs-personalization", + "api-playground/overview", { - "group": "Authentication Setup", + "group": "OpenAPI", + "icon": "brackets-curly", "pages": [ - "settings/authentication-personalization/authentication-setup/choosing-a-handshake", - "settings/authentication-personalization/authentication-setup/password", - "settings/authentication-personalization/authentication-setup/jwt", - "settings/authentication-personalization/authentication-setup/oauth", - "settings/authentication-personalization/authentication-setup/mintlify" + "api-playground/openapi/setup", + "api-playground/openapi/writing-openapi", + "api-playground/openapi/advanced-features" ] }, { - "group": "Personalization Setup", + "group": "MDX", + "icon": "markdown", "pages": [ - "settings/authentication-personalization/personalization-setup/choosing-a-handshake", - "settings/authentication-personalization/personalization-setup/shared-session", - "settings/authentication-personalization/personalization-setup/jwt", - "settings/authentication-personalization/personalization-setup/oauth" + "api-playground/mdx/configuration", + "api-playground/mdx/authentication" ] }, - "settings/authentication-personalization/sending-data" + "api-playground/troubleshooting" ] }, { - "group": "Dashboard Access", - "icon": "house-lock", + "group": "Configurations", "pages": [ - "advanced/dashboard/sso", - "advanced/dashboard/permissions" + "settings/custom-domain", + "settings/seo", + "settings/llms", + "settings/custom-scripts", + "settings/broken-links", + "settings/github", + "settings/gitlab", + "settings/ci", + "settings/preview-deployments" ] }, { - "group": "Model Context Protocol", - "icon": "server", - "pages": ["advanced/mcp/quickstart", "advanced/mcp/generate"] - }, - { - "group": "REST API", - "icon": "brackets-curly", + "group": "Advanced", "pages": [ - "advanced/rest-api/overview", { - "group": "Updates", + "group": "Custom Subdirectory", + "icon": "folder", + "pages": [ + "advanced/subpath/cloudflare", + "advanced/subpath/route53-cloudfront", + "advanced/subpath/vercel" + ] + }, + { + "group": "Auth & Personalization", + "icon": "user-lock", + "pages": [ + "settings/authentication-personalization/authentication", + "settings/authentication-personalization/partial-authentication", + "settings/authentication-personalization/personalization", + "settings/authentication-personalization/authentication-vs-personalization", + { + "group": "Authentication Setup", + "pages": [ + "settings/authentication-personalization/authentication-setup/choosing-a-handshake", + "settings/authentication-personalization/authentication-setup/password", + "settings/authentication-personalization/authentication-setup/jwt", + "settings/authentication-personalization/authentication-setup/oauth", + "settings/authentication-personalization/authentication-setup/mintlify" + ] + }, + { + "group": "Personalization Setup", + "pages": [ + "settings/authentication-personalization/personalization-setup/choosing-a-handshake", + "settings/authentication-personalization/personalization-setup/shared-session", + "settings/authentication-personalization/personalization-setup/jwt", + "settings/authentication-personalization/personalization-setup/oauth" + ] + }, + "settings/authentication-personalization/sending-data" + ] + }, + { + "group": "Dashboard Access", + "icon": "house-lock", + "pages": [ + "advanced/dashboard/sso", + "advanced/dashboard/permissions" + ] + }, + { + "group": "Model Context Protocol", + "icon": "server", "pages": [ - "advanced/rest-api/update/trigger", - "advanced/rest-api/update/status" + "advanced/mcp/quickstart", + "advanced/mcp/generate" ] }, { - "group": "Chat API", + "group": "REST API", + "icon": "brackets-curly", "pages": [ - "advanced/rest-api/chat/create-topic", - "advanced/rest-api/chat/generate-message" + "advanced/rest-api/overview", + { + "group": "Updates", + "pages": [ + "advanced/rest-api/update/trigger", + "advanced/rest-api/update/status" + ] + }, + { + "group": "Chat API", + "pages": [ + "advanced/rest-api/chat/create-topic", + "advanced/rest-api/chat/generate-message" + ] + } ] } ] } ] - } - ] - }, - { - "dropdown": "Components", - "icon": "block-brick", - "description": "Component library", - "groups": [ + }, { - "group": "Components", - "pages": [ - "content/components/accordions", - "content/components/accordion-groups", - "content/components/callouts", - "content/components/cards", - "content/components/card-groups", - "content/components/code", - "content/components/code-groups", - "content/components/frames", - "content/components/icons", - "content/components/mermaid-diagrams", - "content/components/steps", - "content/components/tabs", - "content/components/tooltips", - "content/components/update" + "dropdown": "Components", + "icon": "block-brick", + "description": "Component library", + "groups": [ + { + "group": "Components", + "pages": [ + "content/components/accordions", + "content/components/accordion-groups", + "content/components/callouts", + "content/components/cards", + "content/components/card-groups", + "content/components/code", + "content/components/code-groups", + "content/components/frames", + "content/components/icons", + "content/components/mermaid-diagrams", + "content/components/steps", + "content/components/tabs", + "content/components/tooltips", + "content/components/update" + ] + }, + { + "group": "API Components", + "pages": [ + "content/components/params", + "content/components/responses", + "content/components/expandables", + "content/components/sticky-examples" + ] + } + ] + }, + { + "dropdown": "Integrations", + "icon": "plug", + "description": "Connect your providers", + "groups": [ + { + "group": "Analytics", + "pages": [ + "integrations/analytics/overview", + "integrations/analytics/amplitude", + "integrations/analytics/clearbit", + "integrations/analytics/fathom", + "integrations/analytics/google-analytics", + "integrations/analytics/google-tag-manager", + "integrations/analytics/heap", + "integrations/analytics/hotjar", + "integrations/analytics/koala", + "integrations/analytics/logrocket", + "integrations/analytics/mixpanel", + "integrations/analytics/pirsch", + "integrations/analytics/plausible", + "integrations/analytics/posthog", + "integrations/analytics/segment" + ] + }, + { + "group": "SDKs", + "pages": [ + "integrations/sdks/speakeasy", + "integrations/sdks/stainless" + ] + }, + { + "group": "Support", + "pages": [ + "integrations/support/overview", + "integrations/support/intercom", + "integrations/support/front" + ] + }, + { + "group": "Privacy", + "pages": [ + "integrations/privacy/overview", + "integrations/privacy/osano" + ] + } ] }, { - "group": "API Components", - "pages": [ - "content/components/params", - "content/components/responses", - "content/components/expandables", - "content/components/sticky-examples" + "dropdown": "Changelog", + "icon": "list-timeline", + "description": "Updates and changes", + "groups": [ + { + "group": "Changelog", + "pages": [ + "changelog/overview" + ] + } ] } ] }, { - "dropdown": "Integrations", - "icon": "plug", - "description": "Connect your providers", - "groups": [ + "language": "pt-BR", + "dropdowns": [ { - "group": "Analytics", - "pages": [ - "integrations/analytics/overview", - "integrations/analytics/amplitude", - "integrations/analytics/clearbit", - "integrations/analytics/fathom", - "integrations/analytics/google-analytics", - "integrations/analytics/google-tag-manager", - "integrations/analytics/heap", - "integrations/analytics/hotjar", - "integrations/analytics/koala", - "integrations/analytics/logrocket", - "integrations/analytics/mixpanel", - "integrations/analytics/pirsch", - "integrations/analytics/plausible", - "integrations/analytics/posthog", - "integrations/analytics/segment" + "dropdown": "Getting Started", + "icon": "book", + "description": "Set up your documentation", + "groups": [ + { + "group": "Getting Started", + "pages": [ + "pt-BR/quickstart", + "pt-BR/settings/global", + "pt-BR/themes", + "pt-BR/migration" + ] + }, + { + "group": "Writing Content", + "pages": [ + "pt-BR/page", + "pt-BR/text", + "pt-BR/image-embeds", + "pt-BR/list-table", + "pt-BR/code", + "pt-BR/reusable-snippets" + ] + }, + { + "group": "API References", + "pages": [ + "pt-BR/api-playground/overview", + "pt-BR/api-playground/troubleshooting" + ] + }, + { + "group": "Configurations", + "pages": [ + "pt-BR/settings/custom-domain", + "pt-BR/settings/seo", + "pt-BR/settings/llms", + "pt-BR/settings/custom-scripts", + "pt-BR/settings/broken-links", + "pt-BR/settings/github", + "pt-BR/settings/gitlab", + "pt-BR/settings/ci", + "pt-BR/settings/preview-deployments" + ] + }, + { + "group": "Advanced", + "pages": [] + } ] }, { - "group": "SDKs", - "pages": [ - "integrations/sdks/speakeasy", - "integrations/sdks/stainless" + "dropdown": "Components", + "icon": "block-brick", + "description": "Component library", + "groups": [ + { + "group": "Components", + "pages": [ + "pt-BR/content/components/accordions", + "pt-BR/content/components/accordion-groups", + "pt-BR/content/components/callouts", + "pt-BR/content/components/cards", + "pt-BR/content/components/card-groups", + "pt-BR/content/components/code", + "pt-BR/content/components/code-groups", + "pt-BR/content/components/frames", + "pt-BR/content/components/icons", + "pt-BR/content/components/mermaid-diagrams", + "pt-BR/content/components/steps", + "pt-BR/content/components/tabs", + "pt-BR/content/components/tooltips", + "pt-BR/content/components/update" + ] + }, + { + "group": "API Components", + "pages": [ + "pt-BR/content/components/params", + "pt-BR/content/components/responses", + "pt-BR/content/components/expandables", + "pt-BR/content/components/sticky-examples" + ] + } ] }, { - "group": "Support", - "pages": [ - "integrations/support/overview", - "integrations/support/intercom", - "integrations/support/front" + "dropdown": "Integrations", + "icon": "plug", + "description": "Connect your providers", + "groups": [ + { + "group": "Analytics", + "pages": [ + "pt-BR/integrations/analytics/overview", + "pt-BR/integrations/analytics/amplitude", + "pt-BR/integrations/analytics/clearbit", + "pt-BR/integrations/analytics/fathom", + "pt-BR/integrations/analytics/google-analytics", + "pt-BR/integrations/analytics/google-tag-manager", + "pt-BR/integrations/analytics/heap", + "pt-BR/integrations/analytics/hotjar", + "pt-BR/integrations/analytics/koala", + "pt-BR/integrations/analytics/logrocket", + "pt-BR/integrations/analytics/mixpanel", + "pt-BR/integrations/analytics/pirsch", + "pt-BR/integrations/analytics/plausible", + "pt-BR/integrations/analytics/posthog", + "pt-BR/integrations/analytics/segment" + ] + }, + { + "group": "SDKs", + "pages": [ + "pt-BR/integrations/sdks/speakeasy", + "pt-BR/integrations/sdks/stainless" + ] + }, + { + "group": "Support", + "pages": [ + "pt-BR/integrations/support/overview", + "pt-BR/integrations/support/intercom", + "pt-BR/integrations/support/front" + ] + }, + { + "group": "Privacy", + "pages": [ + "pt-BR/integrations/privacy/overview", + "pt-BR/integrations/privacy/osano" + ] + } ] }, { - "group": "Privacy", - "pages": [ - "integrations/privacy/overview", - "integrations/privacy/osano" + "dropdown": "Changelog", + "icon": "list-timeline", + "description": "Updates and changes", + "groups": [ + { + "group": "Changelog", + "pages": [ + "pt-BR/changelog/overview" + ] + } ] } ] - }, - { - "dropdown": "Changelog", - "icon": "list-timeline", - "description": "Updates and changes", - "groups": [ - { - "group": "Changelog", - "pages": ["changelog/overview"] - } - ] } ] }, - "logo": { - "light": "/logo/light.svg", - "dark": "/logo/dark.svg", - "href": "https://mintlify.com" - }, - "api": { - "mdx": { - "auth": { - "method": "bearer" - } - } - }, - "navbar": { - "links": [ - { - "label": "Community", - "href": "https://mintlify.com/community" - } - ], - "primary": { - "type": "button", - "label": "Get Started", - "href": "https://mintlify.com/start" - } - }, "footer": { "socials": { "x": "https://x.com/mintlify", @@ -373,6 +540,11 @@ } }, "contextual": { - "options": ["copy", "view", "chatgpt", "claude"] + "options": [ + "copy", + "view", + "chatgpt", + "claude" + ] } -} +} \ No newline at end of file diff --git a/pt-BR/advanced/dashboard/permissions.mdx b/pt-BR/advanced/dashboard/permissions.mdx new file mode 100644 index 000000000..c5713bc3a --- /dev/null +++ b/pt-BR/advanced/dashboard/permissions.mdx @@ -0,0 +1,16 @@ +--- +title: Permissões do Editor +description: Permita que mais membros da sua equipe atualizem sua documentação +--- + +O membro da equipe que criou sua documentação inicial terá acesso para atualizá-la, desde que faça push para o repositório de documentação com a mesma conta do GitHub que foi usada ao se cadastrar no Mintlify. + +Se outro editor tentar atualizar a documentação enquanto estiver no plano gratuito, você verá um aviso na verificação do commit do git. + + + + + +Nos detalhes do aviso de verificação do git, você encontrará o link para fazer upgrade do seu plano. Você também pode fazer upgrade do seu plano no [painel](https://dashboard.mintlify.com) para permitir que editores ilimitados atualizem sua documentação. Depois de fazer upgrade do seu plano, acione uma atualização manual ou faça push de outra alteração para implantar suas atualizações. + +Saiba mais sobre nossos preços [aqui](https://mintlify.com/pricing). diff --git a/pt-BR/advanced/dashboard/sso.mdx b/pt-BR/advanced/dashboard/sso.mdx new file mode 100644 index 000000000..43e842360 --- /dev/null +++ b/pt-BR/advanced/dashboard/sso.mdx @@ -0,0 +1,104 @@ +--- +title: Login Único (SSO) +description: Personalize como sua equipe pode fazer login no painel de administração +--- + +Use login único para seu painel através de SAML e OIDC. Se você usa Okta ou Google Workspace, temos documentação específica para configurar SSO, mas se você usa outro provedor, entre em contato conosco! + + + A funcionalidade SSO está disponível em nosso plano Enterprise.[Contate-nos](https://mintlify.com/enterprise) para saber mais! + + +## Okta + + + + + + Em `Applications`, clique para criar uma nova integração de aplicativo usando SAML 2.0. + + + + Insira o seguinte: + + * URL de login único (fornecido pela Mintlify) + * URI de audiência (fornecido pela Mintlify) + * Formato do ID do Nome: `EmailAddress` + * Declarações de Atributos: + | Nome | Formato do nome | Valor | + | ----------- | --------------- | ---------------- | + | `firstName` | Básico | `user.firstName` | + | `lastName` | Básico | `user.lastName` | + + + + Depois que o aplicativo estiver configurado, navegue até a aba de login e nos envie a URL dos metadados. + Nós habilitaremos a conexão do nosso lado usando essas informações. + + + + + + + + Em `Applications`, clique para criar uma nova integração de aplicativo usando OIDC. + Você deve escolher o tipo de aplicativo `Web Application`. + + + + Selecione o tipo de concessão de código de autorização e insira o URI de Redirecionamento fornecido pela Mintlify. + + + + Depois que o aplicativo estiver configurado, navegue até a aba Geral e localize o ID do cliente e o segredo do cliente. + Por favor, nos forneça esses dados de forma segura, junto com a URL da sua instância Okta (por exemplo, `.okta.com`). Você pode enviar esses dados através de um serviço como 1Password ou SendSafely. + + + + + +## Google Workspace + + + + + + Em `Web and mobile apps`, selecione `Add custom SAML app` do menu `Add app`. + + + ![](/images/gsuite-add-custom-saml-app.png) + + + + + Copie a URL SSO fornecida, o ID da Entidade e o certificado x509 e envie para a equipe Mintlify. + + + ![](/images/gsuite-saml-metadata.png) + + + + + Na página de detalhes do Provedor de serviços, insira o seguinte: + + * URL ACS (fornecido pela Mintlify) + * ID da Entidade (fornecido pela Mintlify) + * Formato do ID do Nome: `EMAIL` + * ID do Nome: `Basic Information > Primary email` + + + ![](/images/gsuite-sp-details.png) + + + Na próxima página, insira as seguintes declarações de atributos: + + | Atributo do Diretório Google | Atributo do Aplicativo | + | ---------------------------- | ---------------------- | + | `First name` | `firstName` | + | `Last name` | `lastName` | + + Depois que esta etapa estiver concluída e os usuários forem atribuídos ao aplicativo, avise nossa equipe e habilitaremos o SSO para sua conta! + + + + diff --git a/pt-BR/advanced/mcp/generate.mdx b/pt-BR/advanced/mcp/generate.mdx new file mode 100644 index 000000000..f06502372 --- /dev/null +++ b/pt-BR/advanced/mcp/generate.mdx @@ -0,0 +1,41 @@ +--- +title: MCP Generator +description: Aprenda como configurar seu próprio Servidor MCP +--- + + + Esta página é dedicada à configuração do seu próprio Servidor MCP. Se você está procurando informações sobre como usar o Servidor Mintlify MCP, consulte a + [Instalando e usando o Servidor Mintlify MCP](/advanced/mcp/quickstart) página. + + +## Começando + +Execute `npm i @mintlify/mcp` para instalar o `@mintlify/mcp` CLI. + +No [painel](https://dashboard.mintlify.com/products/mcp) vá para `MCP Server`, nesta página alterne para ver seu comando de instalação único. Este é o comando para instalar seu Servidor MCP com o `@mintlify/mcp` CLI. + + + Certifique-se de ativar o acesso OpenAPI para permitir que o servidor MCP acesse **todos** + os endpoints em sua especificação OpenAPI. + + +## Iniciar o servidor MCP localmente + + + + Execute o seguinte comando para instalar o servidor: + + ```bash + npx @mintlify/mcp add [your subdomain] + ``` + + + + Se sua API requer um token de autenticação, instrua seu cliente final a obtê-lo e aplicá-lo quando receber esta resposta: `> What is the Authorization + (basic token)?` Caso contrário, você pode pular esta etapa. + + + + Agora você pode executar: `bash npm --prefix ~/.mcp/[your subdomain] start ` + + diff --git a/pt-BR/advanced/mcp/quickstart.mdx b/pt-BR/advanced/mcp/quickstart.mdx new file mode 100644 index 000000000..4bff76e19 --- /dev/null +++ b/pt-BR/advanced/mcp/quickstart.mdx @@ -0,0 +1,97 @@ +--- +title: Início Rápido +description: Gere um servidor MCP para ajudar a conectar seu produto aos LLMs +--- + +## Introdução + +O Gerador MCP é uma ferramenta CLI que gera um servidor MCP baseado na documentação da sua empresa e especificação OpenAPI, se disponível. Ele recebe sua documentação e uma especificação OpenAPI e gera um servidor MCP que pode ser usado com qualquer cliente MCP. O Gerador MCP é disponibilizado via[pacote npm](https://www.npmjs.com/package/mcp) e gera um servidor MCP que pode ser usado com qualquer cliente MCP. + +O Mintlify permite que você crie um servidor MCP que permite que ferramentas de IA interajam com seus documentos nestes cenários principais: + +1. **Perguntas e Respostas sobre Docs**, similar ao nosso Chat de IA. Isso é automaticamente habilitado para seus documentos, sem necessidade de configuração. +2. **Consulta de API em tempo real**, se você tem uma especificação OpenAPI, vá para o`Mintlify Dashboard > Products > MCP Server` e ative o toggle para habilitar sua especificação OpenAPI. + + + Ao ativar o toggle OpenAPI, você está permitindo que o servidor MCP acesse + **todos** os endpoints em sua especificação OpenAPI. + + +## Instale o servidor MCP + + + Esta página é dedicada ao Servidor MCP do Mintlify. Se você está procurando informações sobre como gerar seu MCP, consulte a página[Gerador MCP](/advanced/mcp/generate). + + +## Exemplo de instalação com o servidor MCP do Mintlify + +Para usar o servidor MCP do Mintlify você precisará de uma[chave de API](https://mintlify.com/docs/advanced/rest-api/overview#authentication) da sua conta Mintlify. Se você não tem uma, navegue até`Settings > API Keys > Chat API Key` e crie uma nova chave. + +## Inicie o servidor MCP localmente + + + + Execute o seguinte comando para instalar o servidor: + + ```bash + npx @mintlify/mcp add mintlify + ``` + + + + A seguinte resposta será dada após executar o comando anterior: + + ``` + > What is the Authorization (basic token)? + ``` + + Usando sua chave de chat API, copie o token de autenticação e cole-o no CLI. + + + + Agora você pode executar: + + ```bash + npm --prefix ~/.mcp/mintlify start + ``` + + + +## Use seu servidor com Claude + + + Baixe o[Aplicativo Desktop Claude](https://claude.ai/download) + + +Depois de ter o Aplicativo Desktop Claude instalado, siga estes passos: + + + + + + Adicione o seguinte ao`claude_desktop_config.json`: + + ```json + { + "mcpServers": { + "mintlify": { + "command": "npm", + "args": [ + "--prefix", + "~/.mcp/mintlify", + "start" + ] + } + } + } + ``` + + + + Se você clicar nele, deverá ver as Ferramentas MCP disponíveis em seu servidor. + + + ![Claude MCP](/images/mcp-with-claude.png) + + + diff --git a/pt-BR/advanced/rest-api/chat/create-topic.mdx b/pt-BR/advanced/rest-api/chat/create-topic.mdx new file mode 100644 index 000000000..dc00663e3 --- /dev/null +++ b/pt-BR/advanced/rest-api/chat/create-topic.mdx @@ -0,0 +1,3 @@ +--- +openapi: POST /chat/topic +--- diff --git a/pt-BR/advanced/rest-api/chat/generate-message.mdx b/pt-BR/advanced/rest-api/chat/generate-message.mdx new file mode 100644 index 000000000..b1cdbbb37 --- /dev/null +++ b/pt-BR/advanced/rest-api/chat/generate-message.mdx @@ -0,0 +1,3 @@ +--- +openapi: POST /chat/message +--- diff --git a/pt-BR/advanced/rest-api/overview.mdx b/pt-BR/advanced/rest-api/overview.mdx new file mode 100644 index 000000000..32eb4038a --- /dev/null +++ b/pt-BR/advanced/rest-api/overview.mdx @@ -0,0 +1,38 @@ +--- +title: Overview +--- + +## Acionar Atualizações + +Você pode aproveitar a API REST para acionar programaticamente uma atualização quando desejar. + + + Embora o caso de uso principal seja acionar atualizações, adicionaremos cada vez mais + funcionalidades à API ao longo do tempo. Deixe-nos saber o que mais você quer ver em + [nossa comunidade](https://mintlify.com/community)! + + +## Autenticação + +Você pode gerar uma chave de API através do +[painel](https://dashboard.mintlify.com/settings/organization/api-keys). A chave de API está associada a toda a organização e pode ser usada em várias implantações. + + + + + +## Chave de API Admin + +A chave de API Admin é usada para a maioria das APIs. Ela é usada para acionar atualizações através do [endpoint de Atualização](/advanced/rest-api/update/trigger). + +## Chave de API de Chat + +A API de Chat permite que você incorpore a experiência de chat com IA baseada em seus documentos e continuamente atualizada em qualquer aplicação de sua escolha. + +As respostas incluem citações para que você possa direcionar seus usuários aos lugares certos onde precisam obter ajuda. + + + O token da API de Chat é um token público que pode ser referenciado em seu código frontend, enquanto a chave de API é um token do lado do servidor que deve ser mantido em segredo. + + +Agora que você tem uma chave de API, confira nosso [exemplo](https://github.com/mintlify/discovery-api-example) para saber como usar a API para chat com IA. Você também pode ver uma versão implantada deste exemplo em [chat.mintlify.com](https://chat.mintlify.com). diff --git a/pt-BR/advanced/rest-api/update/status.mdx b/pt-BR/advanced/rest-api/update/status.mdx new file mode 100644 index 000000000..0bc6efc18 --- /dev/null +++ b/pt-BR/advanced/rest-api/update/status.mdx @@ -0,0 +1,3 @@ +--- +openapi: GET /project/update-status/{statusId} +--- diff --git a/pt-BR/advanced/rest-api/update/trigger.mdx b/pt-BR/advanced/rest-api/update/trigger.mdx new file mode 100644 index 000000000..8d47fe1e6 --- /dev/null +++ b/pt-BR/advanced/rest-api/update/trigger.mdx @@ -0,0 +1,3 @@ +--- +openapi: POST /project/update/{projectId} +--- diff --git a/pt-BR/advanced/subpath/cloudflare.mdx b/pt-BR/advanced/subpath/cloudflare.mdx new file mode 100644 index 000000000..92b7f83ee --- /dev/null +++ b/pt-BR/advanced/subpath/cloudflare.mdx @@ -0,0 +1,75 @@ +--- +title: Cloudflare +description: Hospede documentação em um subpath /docs usando Cloudflare Workers +--- + +## Criar Worker Cloudflare + +Navegue até o `Workers & Pages > Create application > Create worker`. Você deve ver a seguinte tela onde você pode criar um novo worker do Cloudflare. + + + Create a Cloudflare worker + + + + Lembre-se: Se seu provedor DNS for o Cloudflare, você não deve usar proxy para o registro CNAME + + +### Adicionar domínio personalizado + +Depois que o worker for criado, clique em `Configure worker`. Navegue até o worker +`Settings > Triggers`. Clique em `Add Custom Domain` para adicionar seu domínio desejado à lista - recomendamos que você adicione tanto a versão com quanto sem `www.` +prefixado ao domínio. + + + Cloudflare worker custom domain + + +Se você tiver problemas para configurar um subdiretório personalizado, +[entre em contato com nossa equipe de suporte](mailto:sales@mintlify.com) e nós o ajudaremos a atualizar sua hospedagem conosco. + +### Editar Script do Worker + +Clique em `Edit Code` e adicione o seguinte script no código do worker. + + + Cloudflare edit code + + + + Edite `DOCS_URL` substituindo `[SUBDOMAIN]` pelo seu subdomínio único e`CUSTOM_URL` pela URL base do seu site. + + +```javascript +addEventListener("fetch", (event) => { + event.respondWith(handleRequest(event.request)); +}); + +async function handleRequest(request) { + try { + const urlObject = new URL(request.url); + // If the request is to the docs subdirectory + if (/^\/docs/.test(urlObject.pathname)) { + // Then Proxy to Mintlify + const DOCS_URL = "[SUBDOMAIN].mintlify.dev"; + const CUSTOM_URL = "[YOUR_DOMAIN]"; + + let url = new URL(request.url); + url.hostname = DOCS_URL; + + let proxyRequest = new Request(url, request); + + proxyRequest.headers.set("Host", DOCS_URL); + proxyRequest.headers.set("X-Forwarded-Host", CUSTOM_URL); + proxyRequest.headers.set("X-Forwarded-Proto", "https"); + + return await fetch(proxyRequest); + } + } catch (error) { + // if no action found, play the regular request + return await fetch(request); + } +} +``` + +Clique em `Deploy` e aguarde a propagação das alterações (pode levar até algumas horas). diff --git a/pt-BR/advanced/subpath/route53-cloudfront.mdx b/pt-BR/advanced/subpath/route53-cloudfront.mdx new file mode 100644 index 000000000..f0e004fc1 --- /dev/null +++ b/pt-BR/advanced/subpath/route53-cloudfront.mdx @@ -0,0 +1,137 @@ +--- +title: AWS Route 53 e Cloudfront +sidebarTitle: AWS +description: Hospede documentação em um subdiretório /docs usando serviços AWS +--- + +## Criar Distribuição Cloudfront + +Navegue até [Cloudfront](https://aws.amazon.com/cloudfront) dentro do console AWS e clique em `Create distribution` + + + ![Cloudfront Create Distribution](/images/cloudfront/create-distribution.png) + + +Para o domínio de origem, insira `[SUBDOMAIN].mintlify.dev` onde `[SUBDOMAIN]` é o subdomínio único do projeto. Clique em `Use: [SUBDOMAIN].mintlify.dev` + +![Cloudfront Origin name](/images/cloudfront/origin-name.png) + +Para **Chave de cache e solicitações de origem**, selecione `Caching Optimized`. + + + ![Cloudfront Caching policy](/images/cloudfront/caching-policy.png) + + +E para **Firewall de Aplicação Web (WAF)**, ative as proteções de segurança + + + ![Cloudfront Caching + policy](/images/cloudfront/enable-security-protections.png) + + +As configurações restantes devem ser padrão. Clique em `Create distribution`. + +## Adicionar Origem Padrão + +Depois de criar a distribuição, navegue até a aba `Origins`. + +![Cloudfront Origins](/images/cloudfront/origins.png) + +Queremos encontrar uma URL de staging que espelhe o domínio principal (example.com). Isso varia muito dependendo de como sua página inicial está hospedada. + + + Por exemplo, se sua página inicial está hospedada no Webflow, você pode usar a URL de staging do Webflow. Ela se pareceria com `.webflow.io`. + + Se você usa Vercel, você usa o domínio `.vercel.app` disponível para cada projeto. + + + + Se você não tem certeza de como obter uma URL de staging para sua página inicial, [entre em + contato](mailto:support@mintlify.com) e teremos prazer em ajudar + + +Depois que você tiver a URL de staging, a nossa por exemplo é [mintlify-landing-page.vercel.app](https://mintlify-landing-page.vercel.app), crie uma nova Origem e adicione-a como **Domínio de origem**. + + + ![Cloudfront Default Origins](/images/cloudfront/default-origin.png) + + +Neste ponto, você deve ter duas Origens - uma com `[SUBDOMAIN].mintlify.app` e outra com a URL de staging. + +## Configurar Comportamentos + +Comportamentos no Cloudfront permitem controle sobre a lógica de subpath. Em alto nível, queremos criar a seguinte lógica. + +* **Se um usuário acessa /docs**, vá para `[SUBDOMAIN].mintlify.dev` +* **Se um usuário acessa qualquer outra página**, vá para a página inicial atual + +Vamos criar três comportamentos clicando no botão `Create behavior`. + +### `/docs/*` + +O primeiro comportamento deve ter um **Padrão de caminho** de `/docs/*` com **Origem e grupos de origem** apontando para a `.mintlify.dev` URL (no nosso caso `acme.mintlify.dev`) + +![Cloudfront Behavior 1](/images/cloudfront/behavior-1.png) + +Para **Política de cache**, selecione `CachingOptimized` e crie o comportamento. + +### `/docs` + +O segundo comportamento deve ser igual ao primeiro mas com um **Padrão de caminho** de `/docs` e **Origem e grupos de origem** apontando para a mesma `.mintlify.dev` URL. + +![Cloudfront Behavior 2](/images/cloudfront/behavior-2.png) + +### `Default (*)` + +Por último, vamos editar o comportamento `Default (*)`. + + + ![Cloudfront Behavior Default 1](/images/cloudfront/default-behavior-1.png) + + +Vamos alterar o **Origem e grupos de origem** do comportamento padrão para a URL de staging (no nosso caso `mintlify-landing-page.vercel.app`). + + + ![Cloudfront Behavior Default 2](/images/cloudfront/default-behavior-2.png) + + +Clique em `Save changes`. + +## Prévia da Distribuição + +Agora você pode testar se sua distribuição está configurada corretamente indo para a aba `General` e visitando a URL do **Nome de domínio da distribuição**. + + + ![Cloudfront Preview + distribution](/images/cloudfront/preview-distribution.png) + + +Todas as páginas devem ser direcionadas para sua página inicial principal, mas se você anexar`/docs` à URL, você deverá ver o redirecionamento para a instância de documentação do Mintlify. + +## Conectando com o Route53 + +Agora, vamos trazer a funcionalidade da distribuição Cloudfront para seu domínio principal. + + + Para esta seção, você também pode consultar o guia oficial da AWS sobre[Configurando o Amazon Route 53 para rotear tráfego para uma distribuição CloudFront](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-to-cloudfront-distribution.html#routing-to-cloudfront-distribution-config) + + +Navegue até[Route53](https://aws.amazon.com/route53) dentro do console AWS, e clique em`Hosted zone` para seu domínio principal. Clique em`Create record` + + + ![Route 53 create record](/images/cloudfront/route53-create-record.png) + + +Alterne`Alias` e então**Rotear tráfego para** a`Alias to CloudFront distribution` opção. + + + ![Route 53 create record alias](/images/cloudfront/create-record-alias.png) + + +Clique`Create records`. + + + Você pode precisar remover o registro A existente, se houver um atualmente. + + +E pronto! Você deve ser capaz de ter sua documentação servida em`/docs` para seu domínio principal. diff --git a/pt-BR/advanced/subpath/vercel.mdx b/pt-BR/advanced/subpath/vercel.mdx new file mode 100644 index 000000000..696b206f6 --- /dev/null +++ b/pt-BR/advanced/subpath/vercel.mdx @@ -0,0 +1,27 @@ +--- +title: Vercel +description: Hospede documentação em um subpath /docs usando Vercel +--- + +## Configuração do vercel.json + +Para hospedar sua documentação em um subpath personalizado usando Vercel, você precisa adicionar a seguinte configuração ao seu`vercel.json` arquivo. + +```json +{ + "rewrites": [ + { + "source": "/docs", + "destination": "https://[subdomain].mintlify.dev/docs" + }, + { + "source": "/docs/:match*", + "destination": "https://[subdomain].mintlify.dev/docs/:match*" + } + ] +} +``` + + + Para mais informações, você também pode consultar o guia oficial da Vercel sobre reescritas: [Configuração do Projeto: Reescritas](https://vercel.com/docs/projects/project-configuration#rewrites) + diff --git a/pt-BR/api-playground/mdx/authentication.mdx b/pt-BR/api-playground/mdx/authentication.mdx new file mode 100644 index 000000000..11db2cb3a --- /dev/null +++ b/pt-BR/api-playground/mdx/authentication.mdx @@ -0,0 +1,87 @@ +--- +title: Authentication +description: Você pode definir parâmetros de autenticação para permitir que os usuários usem suas chaves de API reais. +--- + +## Habilitando Autenticação + +Você pode adicionar um método de autenticação ao seu docs.json para habilitá-lo em todas as páginas ou pode configurá-lo por página. + +O método de autenticação da página substituirá o docs.json se ambos estiverem definidos. + +### Token Bearer + + + ```json docs.json + "api": { + "mdx": { + "auth": { + "method": "bearer" + } + } + } + ``` + + ```md Page Metadata + --- + title: "Your page title" + authMethod: "bearer" + --- + ``` + + +### Autenticação Básica + + + ```json docs.json + "api": { + "mdx": { + "auth": { + "method": "basic" + } + } + } + ``` + + ```md Page Metadata + --- + title: "Your page title" + authMethod: "basic" + --- + ``` + + +### Chave de API + + + ```json docs.json + "api": { + "mdx": { + "auth": { + "method": "key", + "name": "x-api-key" + } + } + } + ``` + + ```md Page Metadata + --- + title: "Your page title" + authMethod: "key" + --- + ``` + + +### Nenhuma + +O método de autenticação "none" é útil para desabilitar a autenticação em um endpoint específico após definir um padrão no docs.json. + + + ```md Page Metadata + --- + title: "Your page title" + authMethod: "none" + --- + ``` + diff --git a/pt-BR/api-playground/mdx/configuration.mdx b/pt-BR/api-playground/mdx/configuration.mdx new file mode 100644 index 000000000..b21c6a669 --- /dev/null +++ b/pt-BR/api-playground/mdx/configuration.mdx @@ -0,0 +1,70 @@ +--- +title: Configuração MDX +description: Gere páginas de documentação para seus endpoints de API usando MDX +--- + +O Mintlify permite que você defina seus endpoints de API usando uma combinação de`docs.json` configuração, campos de metadados MDX, e o componente``. A partir dos endpoints definidos, geramos um playground de API, exemplos de requisição e exemplos de resposta. + + + + No seu arquivo`docs.json`, defina sua URL base e método de autenticação: + + ```json + "api": { + "mdx": { + "server": "https://mintlify.com/api", // string array for multiple base URLs + "auth": { + "method": "key", + "name": "x-api-key" // options: bearer, basic, key. + } + } + } + ``` + + Se você não quiser mostrar um playground de API, você não precisa incluir tipos de autenticação. Oculte o playground com o seguinte campo: + + ```json + "api": { + "playground": { + "display": "none" + } + } + ``` + + Encontre uma lista completa de configurações de API[aqui](/settings/global#param-api). + + + + Cada página de endpoint de API deve ter um arquivo MDX correspondente. No topo de cada arquivo, defina: + + ```md + --- + title: 'Create new user' + api: 'POST https://api.mintlify.com/user' + --- + ``` + + Você pode especificar parâmetros de caminho adicionando o nome do parâmetro ao caminho, envolvido com`{}`: + + ```bash + https://api.example.com/v1/endpoint/{userId} + ``` + + + Se você tiver`server` configurado em[docs.json](/settings/global), você pode usar caminhos relativos como`/v1/endpoint`. + + + Você também pode substituir o modo de exibição definido globalmente para o playground de API por página adicionando`playground` no topo do arquivo MDX: + + ```md + --- + title: 'Create new user' + api: 'POST https://api.mintlify.com/user' + playground: 'none' + ``` + + + + Adicione suas páginas de endpoint à barra lateral adicionando os caminhos ao `navigation` campo no seu `docs.json`. Saiba mais sobre como estruturar seus documentos [aqui](/settings/navigation). + + diff --git a/pt-BR/api-playground/openapi/advanced-features.mdx b/pt-BR/api-playground/openapi/advanced-features.mdx new file mode 100644 index 000000000..f17a56094 --- /dev/null +++ b/pt-BR/api-playground/openapi/advanced-features.mdx @@ -0,0 +1,139 @@ +--- +title: Recursos Avançados +description: Suporte para recursos avançados do OpenAPI +--- + +O OpenAPI 3 tem alguns recursos avançados para descrever APIs complexas. Aqui está como você pode usá-los com Mintlify. + +## `oneOf`, `anyOf`, `allOf` + +Para tipos de dados complexos, o OpenAPI fornece as palavras-chave `oneOf`, `anyOf`, e `allOf`, permitindo que você combine esquemas de certas maneiras. Você pode ler mais sobre essas palavras-chave na [documentação do Swagger](https://swagger.io/docs/specification/data-models/oneof-anyof-allof-not/), mas essencialmente: + +* `oneOf` funciona como um operador "ou-exclusivo" +* `anyOf` funciona como um operador "ou" +* `allOf` funciona como um operador "e" + +As `oneOf` e `anyOf` palavras-chave são tratadas da mesma forma. Descobrimos que, quando as pessoas usam `oneOf`, elas frequentemente *querem dizer* `anyOf` - e geralmente não há diferença significativa para o usuário. + +A `not` palavra-chave não é atualmente suportada. + +### Combinando esquemas com `allOf` + +O Mintlify realiza algum pré-processamento em seu documento OpenAPI para exibir essas combinações complexas de forma legível. Por exemplo, quando você combina dois esquemas de objeto com `allOf`, o Mintlify combina as propriedades de ambos em um único objeto. Isso se torna especialmente útil ao aproveitar [os componentes reutilizáveis do `components`](https://swagger.io/docs/specification/components/). + +```yaml +org_with_users: + allOf: + - $ref: '#/components/schemas/Org' + - type: object + properties: + users: + type: array + description: An array containing all users in the organization +... +components: + schemas: + Org: + type: object + properties: + id: + type: string + description: The ID of the organization +``` + + + + + O ID da organização + + + + Um array contendo todos os usuários na organização + + + + +### Fornecendo opções com `oneOf` e `anyOf` + +Quando você usa `oneOf` ou `anyOf`, o Mintlify exibe as opções em um container com abas. Para dar nomes úteis às suas opções, certifique-se de dar a cada subesquema um campo `title`. Por exemplo, aqui está como você pode exibir dois tipos diferentes de endereços de entrega: + +```yaml +delivery_address: + oneOf: + - title: StreetAddress + type: object + properties: + address_line_1: + type: string + description: The street address of the recipient + ... + - title: POBox + type: object + properties: + box_number: + type: string + description: The number of the PO Box + ... +``` + + +
+ + + + O endereço da residência + + + + + + O número da Caixa Postal + + + +
+ + +## `x-codeSamples` + +Se seus usuários interagem com sua API usando um SDK em vez de diretamente através de uma requisição de rede, você pode adicionar exemplos de código ao seu documento OpenAPI, e o Mintlify irá exibi-los em suas páginas OpenAPI. Você pode definir seus exemplos de código usando a `x-codeSamples` extensão. Esta propriedade pode ser adicionada dentro de qualquer método de requisição e tem o seguinte esquema: + + + A linguagem do exemplo de código. + + + + O rótulo para o exemplo. Isso é útil quando fornecendo múltiplos exemplos para um único endpoint. + + + + O código-fonte do exemplo. + + +Aqui está um exemplo de alguns exemplos de código para um aplicativo de rastreamento de plantas, que tem tanto uma ferramenta CLI em Bash quanto um SDK JavaScript. + +```yaml +paths: + /plants: + get: + ... + x-codeSamples: + - lang: bash + label: List all unwatered plants + source: | + planter list -u + - lang: javascript + label: List all unwatered plants + source: | + const planter = require('planter'); + planter.list({ unwatered: true }); + - lang: bash + label: List all potted plants + source: | + planter list -p + - lang: javascript + label: List all potted plants + source: | + const planter = require('planter'); + planter.list({ potted: true }); +``` diff --git a/pt-BR/api-playground/openapi/setup.mdx b/pt-BR/api-playground/openapi/setup.mdx new file mode 100644 index 000000000..b3f13de24 --- /dev/null +++ b/pt-BR/api-playground/openapi/setup.mdx @@ -0,0 +1,147 @@ +--- +title: Configuração OpenAPI +description: Referencie endpoints OpenAPI em suas páginas de documentação +--- + +## Adicione um arquivo de especificação OpenAPI + +Para descrever seus endpoints com OpenAPI, certifique-se de ter um documento OpenAPI válido em formato JSON ou YAML que siga a [especificação OpenAPI](https://swagger.io/specification/). Seu documento deve seguir a especificação OpenAPI 3.0+. +Para validar sua especificação OpenAPI, use nossa [CLI](https://www.npmjs.com/package/mintlify) e execute este comando:
`mintlify openapi-check ` + +## Auto-preencher páginas de API + +A maneira mais rápida de começar com OpenAPI é adicionar um campo `openapi` a uma aba no `docs.json`. Este campo pode conter tanto o caminho para um documento OpenAPI em seu repositório de documentação, quanto a URL de um documento OpenAPI hospedado. O Mintlify irá gerar automaticamente uma página para cada operação OpenAPI e colocá-las na aba. + +**Exemplo com Abas:** + +```json {5} +"navigation": { + "tabs": [ + { + "tab": "API Reference", + "openapi": "https://petstore3.swagger.io/api/v3/openapi.json" + } + ] +} +``` + +![](/images/autogeneration-with-tabs.png) + +**Exemplo com Grupos:** + +```json {8-11} +"navigation": { + "tabs": [ + { + "tab": "API Reference", + "groups": [ + { + "group": "Endpoints", + "openapi": { + "source": "/path/to/openapi-1.json", + "directory": "api-reference" + } + } + ] + } + ] +} +``` + +O campo directory é opcional. Se não especificado, os arquivos serão colocados no **api-reference** pasta do repositório de documentação. + +Ao usar esta opção, os metadados para as páginas geradas terão os seguintes valores padrão: + +* `title`: O `summary` campo da operação OpenAPI, se presente. Caso contrário, um título gerado a partir do método HTTP e endpoint. + +* `description`: O `description` campo da operação OpenAPI, se presente. + +* `version`: O `version` valor da âncora ou aba, se presente. + +Existem alguns cenários em que o comportamento padrão não é suficiente. Se você precisar de mais personalização, você pode criar uma página MDX para sua operação OpenAPI e modificá-la como qualquer outra página MDX. + +## Criar arquivos MDX para páginas de API + +Se você quiser personalizar os metadados da página, adicionar conteúdo adicional, omitir certas operações OpenAPI ou reordenar páginas OpenAPI em sua navegação, você precisará de uma página MDX para cada operação. Aqui está [um exemplo de página OpenAPI MDX](https://github.com/mindsdb/mindsdb/blob/main/docs/rest/databases/create-databases.mdx) da [MindsDB](https://docs.mindsdb.com/rest/databases/create-databases). + +![](/images/mindsdb.png) + +### Especificar arquivos manualmente + +Você sempre pode criar uma página MDX manualmente e referenciar a operação OpenAPI nos metadados da página usando o campo `openapi`. + + + +Ao usar a referência OpenAPI, o nome, descrição, parâmetros, respostas e o playground da API serão gerados automaticamente a partir do documento OpenAPI. + +Se você tiver vários arquivos OpenAPI, inclua o caminho para o arquivo OpenAPI para garantir que o Mintlify encontre o documento OpenAPI correto. Isso não é necessário se você tiver apenas um arquivo OpenAPI - ele detectará automaticamente seu arquivo OpenAPI. + +Se você quiser referenciar um arquivo OpenAPI externo usando este método, forneça a URL do arquivo no docs.json. Veja [aqui](https://mintlify.com/docs/settings/global#param-source-4) para o formato correto. + + + ```md Example + --- + title: "Get users" + openapi: "/path/to/openapi-1.json GET /users" + --- + ``` + + ```md Format + --- + title: "title of the page" + openapi: openapi-file-path method path + --- + ``` + + + + Na maioria dos casos, o método e o caminho devem corresponder exatamente ao método e caminho especificados no documento OpenAPI. Se o endpoint não existir no arquivo OpenAPI, a página ficará vazia. + + Para webhooks, substitua o método (por exemplo, "POST") por "webhook" (não diferencia maiúsculas de minúsculas) e o método correto será gerado. + + +### Gerar arquivos automaticamente + +Para documentos OpenAPI grandes, criar uma página MDX para cada operação OpenAPI pode dar muito trabalho. Para facilitar, criamos um scraper local de páginas OpenAPI. + +Nosso Mintlify [scraper](https://www.npmjs.com/package/@mintlify/scraping) +gera automaticamente arquivos MDX para seus endpoints OpenAPI. + +Cada página gerada corresponderá a uma operação OpenAPI na seção "paths" do esquema OpenAPI. Se seu documento OpenAPI for versão 3.1+, o scraper também gerará páginas para webhooks na seção "webhooks" do esquema OpenAPI. + +```bash +npx @mintlify/scraping@latest openapi-file +``` + +Adicione a `-o` flag para especificar uma pasta para popular os arquivos. Se uma pasta não for especificada, os arquivos serão populados no diretório de trabalho. + +```bash +npx @mintlify/scraping@latest openapi-file -o api-reference +``` + +Saiba mais sobre nosso pacote de scraping [aqui](https://www.npmjs.com/package/@mintlify/scraping). + +O scraper irá gerar um array de +[Entradas de navegação](/settings/global#structure) contendo seus arquivos MDX OpenAPI. Você pode anexar essas entradas à sua Navegação existente ou reordenar e adicionar os arquivos à sua navegação manualmente. + + + Se seu documento OpenAPI for inválido, os arquivos não serão gerados automaticamente. + + +## Criar arquivos MDX para esquemas OpenAPI + +O Mintlify também permite que você crie páginas individuais para qualquer esquema OpenAPI definido no campo `components.schemas` do documento OpenAPI: + + + ```md Example + --- + openapi-schema: OrderItem + --- + ``` + + ```md Format + --- + openapi-schema: "schema-key" + --- + ``` + diff --git a/pt-BR/api-playground/openapi/writing-openapi.mdx b/pt-BR/api-playground/openapi/writing-openapi.mdx new file mode 100644 index 000000000..73a9fbad7 --- /dev/null +++ b/pt-BR/api-playground/openapi/writing-openapi.mdx @@ -0,0 +1,33 @@ +--- +title: Escrevendo OpenAPI +description: Use recursos OpenAPI para aprimorar sua documentação +--- + +## Descrevendo sua API + +Existem muitas ótimas ferramentas online para aprender sobre e construir documentos OpenAPI. Aqui estão nossas favoritas: + +* [Guia OpenAPI do Swagger](https://swagger.io/docs/specification/about/) para se familiarizar com a sintaxe OpenAPI +* [Especificação OpenAPI v3.1.0](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md) para todos os detalhes sobre a mais nova especificação OpenAPI +* [Validador Swagger & OpenAPI](https://editor.swagger.io/) para depurar seu documento OpenAPI +* [Editor do Swagger](https://editor.swagger.io/) para ver exemplos em ação + + + O Guia OpenAPI do Swagger é para OpenAPI v3.0, mas quase todas as informações são aplicáveis à v3.1. Para mais informações sobre as diferenças entre v3.0 e v3.1, confira o [post do blog OpenAPI](https://www.openapis.org/blog/2021/02/16/migrating-from-openapi-3-0-to-3-1-0). + + +## Especificando a URL para sua API + +Em um documento OpenAPI, diferentes endpoints da API são especificados por seus caminhos, como `/users/{id}`, ou talvez simplesmente `/`. Para especificar a URL base à qual esses caminhos devem ser anexados, o OpenAPI fornece o campo `servers`. Este campo é necessário para usar alguns recursos do Mintlify como o API Playground. Leia como configurar o campo `servers` na [documentação do Swagger](https://swagger.io/docs/specification/api-host-and-base-path/). + +O API Playground usará essas URLs de servidor para determinar para onde enviar as requisições. Se múltiplos servidores forem especificados, um menu suspenso aparecerá para permitir alternar entre servidores. Se nenhum servidor for fornecido, o API Playground usará o modo simples, pois não há como enviar uma requisição. + +Se diferentes endpoints dentro da sua API existem em diferentes URLs, você pode [sobrescrever o campo server](https://swagger.io/docs/specification/api-host-and-base-path/#:~:text=%C2%A0%C2%A0%C2%A0%C2%A0%C2%A0%C2%A0%C2%A0%C2%A0%C2%A0%20%2D%20southeastasia-,Overriding%20Servers,-The%20global%20servers) para um determinado caminho ou operação. + +## Especificando autenticação + +Quase todas as APIs requerem algum método de autenticação. O OpenAPI fornece o `securitySchemes` campo para definir os métodos de autenticação utilizados em toda a sua API, com configuração simples para os tipos de autenticação mais comuns - [Basic](https://swagger.io/docs/specification/authentication/basic-authentication/), [Bearer](https://swagger.io/docs/specification/authentication/bearer-authentication/), e [Chaves de API](https://swagger.io/docs/specification/authentication/api-keys/). Para aplicar esses métodos de autenticação aos seus endpoints, o OpenAPI usa o `security` campo. A sintaxe para definir e aplicar autenticação é um pouco contraintuitiva, então definitivamente confira a [documentação e exemplos do Swagger](https://swagger.io/docs/specification/authentication/) sobre o assunto. + +As descrições da API e o API Playground adicionarão campos de autenticação com base nas configurações de segurança em seu documento OpenAPI. + +Se diferentes endpoints dentro da sua API requerem diferentes métodos de autenticação, você pode [sobrescrever o campo de segurança](https://swagger.io/docs/specification/authentication/#:~:text=you%20can%20apply%20them%20to%20the%20whole%20API%20or%20individual%20operations%20by%20adding%20the%20security%20section%20on%20the%20root%20level%20or%20operation%20level%2C%20respectively.) para uma determinada operação. diff --git a/pt-BR/api-playground/overview.mdx b/pt-BR/api-playground/overview.mdx new file mode 100644 index 000000000..041d92f89 --- /dev/null +++ b/pt-BR/api-playground/overview.mdx @@ -0,0 +1,13 @@ +--- +title: Playground +description: Permita que os usuários interajam com sua API +openapi: POST /project/update/{projectId} +hideApiMarker: true +icon: play +--- + +O playground da API é um ambiente interativo para fazer requisições e visualizar um endpoint da API. + + + A geração automática de páginas de API com OpenAPI gerará automaticamente o playground da API. Leia mais sobre o uso do OpenAPI[aqui](/api-playground/openapi). + diff --git a/pt-BR/api-playground/troubleshooting.mdx b/pt-BR/api-playground/troubleshooting.mdx new file mode 100644 index 000000000..275b5e326 --- /dev/null +++ b/pt-BR/api-playground/troubleshooting.mdx @@ -0,0 +1,72 @@ +--- +title: Solução de Problemas +description: Problemas comuns com Referências de API +icon: triangle-exclamation +--- + +As páginas de API são complicadas. Como resultado, existem muitas coisas que podem dar errado. +Aqui está uma lista de problemas comuns que vimos os clientes enfrentarem: + + + + Neste cenário, é provável que o Mintlify não consiga encontrar seu documento OpenAPI, + ou seu documento OpenAPI seja inválido. + + Executar `mintlify dev` localmente deve revelar alguns desses problemas. + + Para verificar se seu documento OpenAPI passará na validação: + + 1. Visite [este validador](https://editor.swagger.io/) + 2. Mude para a aba "Validate text" + 3. Cole seu documento OpenAPI + 4. Clique em "Validate it!" + + Se a caixa de texto que aparece abaixo tiver uma borda verde, seu documento passou na validação. + Este é exatamente o pacote de validação que o Mintlify usa para validar documentos OpenAPI, então se seu documento + passar na validação aqui, há uma grande chance de que o problema esteja em outro lugar. + + Além disso, o Mintlify não suporta OpenAPI 2.0. Se seu documento usa esta versão da especificação, + você pode encontrar este problema. Você pode converter seu documento em [editor.swagger.io](https://editor.swagger.io/) (em Edit > Convert to OpenAPI 3): + + + + + + + + Isso geralmente é causado por um erro de digitação no`openapi` campo nos metadados da página. Certifique-se que o método HTTP e o caminho correspondam exatamente ao método HTTP e caminho no documento OpenAPI. + + Aqui está um exemplo de como as coisas podem dar errado: + + ```md get-user.mdx + --- + openapi: "GET /users/{id}/" + --- + ``` + + ```yaml openapi.yaml + paths: + "/users/{id}": + get: ... + ``` + + Observe que o caminho no`openapi` campo tem uma barra no final, enquanto o caminho no documento OpenAPI não tem. + + Outro problema comum é um nome de arquivo digitado incorretamente. Se você está especificando um documento OpenAPI específico no`openapi` campo, certifique-se que o nome do arquivo está correto. Por exemplo, se você tem dois documentos OpenAPI`openapi/v1.json` e`openapi/v2.json`, seus metadados podem parecer assim: + + ```md api-reference/v1/users/get-user.mdx + --- + openapi: "v1 GET /users/{id}" + --- + ``` + + + + Se você tem um domínio personalizado configurado, isso pode ser um problema com seu proxy reverso. Por padrão, as requisições feitas via API Playground começam com uma requisição`POST` para o caminho + `/api/request` no site da documentação. Se seu proxy reverso está configurado para permitir apenas requisições`GET` + todas essas requisições falharão. Para corrigir isso, configure seu proxy reverso para permitir requisições`POST` para o caminho`/api/request`. + + Alternativamente, se seu proxy reverso impede você de aceitar requisições`POST`, você pode configurar o Mintlify para enviar requisições diretamente para seu backend com a configuração`api.playground.disableProxy` + no`docs.json`, como descrito[aqui](/settings/global#api-configurations). Isso provavelmente exigirá que você configure o CORS em seu servidor, já que essas requisições agora virão diretamente dos navegadores dos seus usuários. + + diff --git a/pt-BR/changelog/overview.mdx b/pt-BR/changelog/overview.mdx new file mode 100644 index 000000000..3ef8f2143 --- /dev/null +++ b/pt-BR/changelog/overview.mdx @@ -0,0 +1,396 @@ +--- +title: Atualizações do Produto +description: Novas atualizações e melhorias +mode: center +--- + + + ## Gerador de servidor MCP + + Gere servidores MCP para que aplicações de IA possam interagir com sua documentação 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.](/advanced/mcp/quickstart.mdx) + + ## mcpt: um registro para servidores MCP + + Descubra mais de 105 servidores MCP em [mcpt](https://www.mcpt.com). Este diretório inclui tanto servidores oficiais quanto aqueles de nossa própria base de clientes. + + ## Melhorias + + * Marque atualizações do changelog para que os usuários finais possam filtrar 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 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 em modo simples para o playground da API + * Suporte ao atalho "command + k" para busca no editor web + * Blocos de código dentro de callouts expandem para preencher a largura da área do callout + + + + ## Novo Schema de Configuração`docs.json` + + Introduzimos um novo `docs.json` schema como substituto para `mint.json`, para suportar melhor versionamento multinível, compreensão visual mais fácil e terminologia mais consistente. Para mais informações sobre o que mudou, [confira nosso blog](https://mintlify.com/blog/refactoring-mint-json-into-docs-json). + + Atualize do `mint.json` para `docs.json` com os seguintes passos: + + 1. Certifique-se de que seu CLI está na versão mais recente + + ``` + npm i mintlify@latest -g + ``` + + 1. No seu repositório de documentação, execute + + ``` + mintlify upgrade + ``` + + 1. Exclua seu arquivo mint.json antigo e envie suas alterações + + ## Verificações CI + + Faça lint automaticamente em sua documentação 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](settings/ci). + + ## 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 de sua documentação por LLMs. + + ## Mais Temas + + Novos [temas pré-construídos](/themes) para modificar a aparência de sua documentação. Configure através do seu [arquivo docs.json](/settings/global). + + Agora disponível: + + * Maple + * Palm + * Willow + + ## Outras melhorias + + * [Guia para Escrita Técnica:](https://mintlify.com/guides/introduction)Melhores práticas para escrever documentação técnica, incluindo pesquisa de público, tipos de conteúdo e dicas de escrita. + * [Componente Dropdown](/navigation/divisions#dropdowns): Organize a navegação com um dropdown, além de abas e âncoras. + * [Corretor de sintaxe com IA](https://x.com/ricardonunez_io/status/1892334887644123192): O editor web detectará se há um erro de análise e usará IA para sugerir correções. + + + + ## Melhorias no Assistente de IA + + * Nova UI 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 Renovado + + Reformulamos o design e o desempenho do [Playground da API](/api-playground/). As atualizações incluem: + + * Expansão mais fácil de detalhes para uma visão geral de um campo + * Design aninhado mais intuitivo, por exemplo, adicionar ou excluir itens + * Tempos de resposta mais rápidos + + ## Melhorias de Qualidade + + * Suporte para exigir autenticação para acessar implantações de pré-visualização + + + + ## Autenticação + + + ![Authentication screenshot](/images/changelog/authentication.png) + + + 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 sua documentação. + + + + ## Assistente de IA + + + ![AI Assistant](/images/changelog/ai-assistant.jpg) + + + Agora você pode pedir à IA para fazer alterações em sua documentação, com o contexto de toda a documentação existente. Digite um prompt e o assistente irá propor alterações gerando um pull request. + + ## Atualização da Integração com GitLab + + Melhoramos nosso suporte para sincronização com GitLab, como habilitar atualizações automatizadas e implantações de pré-visualização. Confira nossa [documentação sobre GitLab](/settings/gitlab) para começar. + + ## Editor Web + + + ![Web Editor](/images/changelog/webeditor.jpg) + + + Reformulamos nosso editor web para que você possa atualizar documentos com uma experiência totalmente WYSIWYG, enquanto sincroniza com markdown. + + Confira nossa [documentação sobre como começar com o Editor Web](/web-editor). + + ## Suporte para /llms.txt + + + ![llms.txt support](/images/changelog/llms.jpg) + + + Todas as instâncias de documentação agora são automaticamente hospedadas em /llms.txt e /llms-full.txt para que LLMs possam facilmente ingerir sua documentação. Para mais informações, leia a [documentação sobre o novo padrão llms.txt.](https://llmstxt.org) + + ## Localização + + Agora você pode localizar sua documentação, que funciona de forma semelhante ao versionamento. Adicione um `locale` 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 + + * Retorna resultados de chat e pesquisa baseados na versão atual que o usuário está lendo + * Autenticar usuários com OAuth, além de tokens JWT ou Shared Session. + + + + ## Changelogs + + Lançado um novo [componente de Atualização](/content/components/update) para facilitar a exibição e o relato de atualizações (como esta) para seus usuários. + + + ![Changelog](/images/changelog/changelog.jpg) + + + ## Destaque de Linhas de Código + + Agora você pode destacar linhas de código em sua documentação para enfatizar e chamar 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. + + ```javascript Line Highlighting Example {1,3-5} + const greeting = "Hello, World!"; + function sayHello() { + console.log(greeting); + } + sayHello(); + ``` + + ````md + ```javascript Line Highlighting Example {1,3-5} + const greeting = "Hello, World!"; + function sayHello() { + console.log(greeting); + } + sayHello(); + ``` + ```` + + ## Blocos de código em modo claro + + Os blocos de código agora têm uma variante em modo claro que pode ser ativada adicionando o seguinte ao seu `mint.json`: + + ```json + "codeBlock": { + "mode": "auto" + } + ``` + + ## Rodapé Avançado + + + ![Advanced Footer](/images/changelog/advanced-footer.gif) + + + Agora você pode adicionar mais links ao rodapé padrão. Esta atualização fornece mais consistência entre páginas de destino e 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 conectado 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 o [suporte](mailto:sales@mintlify.com) se você quiser personalizar os prompts. + + ## Melhorias no Painel + + * Adicionada a capacidade de alterar o domínio personalizado para /docs diretamente através das configurações do painel. + * Consolidadas as páginas de login e cadastro para diminuir o atrito e a confusão. + * Implementado o fluxo de login de descoberta para que usuários que são membros de múltiplas organizações possam agora alternar entre elas. + * Adicionado login com Google OAuth + * Adicionada 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 & JS no editor web. + * Corrigido `suggestEdit` não aparecendo mesmo quando habilitado. + * Corrigida a navegação por teclado para Pesquisa e Chat, 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. + * Adicionar suporte para estilo em linha para ícones + * Corrigido o pop-in do CSS personalizado nos documentos. + * Exibição adequada do estilo de código em linha em conjunto com links. + * Manutenção da posição de rolagem ao clicar no botão voltar do navegador. + + + + ## Fontes Personalizadas + + + ![Custom Fonts](/images/changelog/custom-fonts.jpeg) + + + 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 `img` propriedade a um card para exibir uma imagem no topo do card. Saiba mais sobre isso [aqui](/content/components/cards#image-card). + + ## Melhorias na Velocidade de Atualização + + + ![Performance Improvements](/images/changelog/performance-improvements.png) + + + 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 + + + ![SEO Improvements](/images/changelog/seo-improvements.jpeg) + + + Corrigimos o layout móvel e desktop de nossos documentos para que sejam mais amigáveis ao 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 aplicativo 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 é `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](/api-playground/troubleshooting) + + + + ## Páginas de Referência OpenAPI + + * Endpoints definidos por OpenAPI que são complexos e recursivos agora são 98% menores. + * Agora mostramos + [additionalProperties](https://swagger.io/docs/specification/data-models/dictionaries/) + nas páginas OpenAPI. + + ## Upload de Arquivos no API Playground + + Por padrão, as requisições do API playground são proxy pelo Mintlify. Agora você pode usar + `disableProxy` para desabilitar esse comportamento e suportar tipos de requisição como upload de arquivos. + + * [Saiba mais sobre configurações de API](/settings/global#api-configurations) + + ## Melhorias de SEO para dispositivos móveis + + Corrigimos o layout móvel de nossos documentos para que sejam mais amigáveis ao 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 com o Segment. + * Agora exibimos mensagens de erro mais detalhadas para permissões do GitHub ao interagir com o editor. + * Corrigidos bugs onde a navegação não expandia adequadamente quando um link direto era usado. + + + + ## Widget de IA + + + ![AI Widget](/images/changelog/widget.png) + + + Para `Pro` usuários, introduzimos o Mintlify Widget, uma extensão de seus documentos 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 web: sua página inicial, dentro do seu produto ou em suas páginas de documentação existentes. + + * [Leia o anúncio no blog](https://mintlify.com/blog/widget) + + ## Plano Pro + + Também atualizamos nossos planos de preços para melhor personalização e escala. + + * [Leia o anúncio no blog](https://mintlify.com/blog/pro-plan) + + ## Sincronização de Exemplos 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 + + * Temas: Personalize seu estilo com temas pré-configurados. Basta adicionar o tema Quill, Prism ou Venus ao seu `mint.json` arquivo e ele atualizará o estilo dos seus documentos. + * Pesquisa 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 pesquisa e aproveite nossa interface de barra de pesquisa atualizada. + * Ramificação do Editor Web: crie ramificações em nosso editor web sem necessidade de 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 da Automação OpenAPI: para preencher automaticamente páginas do API Playground, você pode adicionar um`openapi` campo a um objeto nas matrizes de abas ou âncoras no mint.json. + + + + ## Okta SSO + + Agora suportamos login via Okta SAML e OIDC. + + ## Mintlify REST API + + Atualize programaticamente sua documentação. + + + + ## Modo personalizado + + Adicione uma configuração aos metadados para remover todos os elementos exceto a barra superior. + Casos de uso exemplo: + + * 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 nossa [documentação do Modo Personalizado](/page#custom-mode). + + + + ## Mintlify MDX para VSCode + + Chame trechos de nossos componentes e callouts pré-construídos sem sair do VSCode.[Instale a extensão aqui](https://marketplace.visualstudio.com/items?itemName=mintlify.mintlify-snippets). + + + + ## 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 Erro CLI: agora mostramos a posição do frontmatter inválido quando há problemas de análise durante o desenvolvimento local + + + + ## Destaques da Semana de Lançamento + + * Implantações de Prévia: 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 destaque de sintaxe de código.[Contribuições para o projeto](https://github.com/mintlify/mdx) são bem-vindas. + * Insights do Chat AI: Segmente o histórico de chat por data e aumente a cota do Chat AI pelo painel, e veja com que frequência uma consulta específica aparece. + diff --git a/pt-BR/code.mdx b/pt-BR/code.mdx new file mode 100644 index 000000000..b9c72e33b --- /dev/null +++ b/pt-BR/code.mdx @@ -0,0 +1,39 @@ +--- +title: Blocos de Código +description: Exibir código inline e blocos de código +icon: code +--- + +## Básico + +### Código Inline + +Para denotar um `word` ou `phrase` como código, coloque-o entre acentos graves (\`). + +``` +To denote a `word` or `phrase` as code, enclose it in backticks (`). +``` + +### Bloco de Código + +Use [blocos de código cercados](https://www.markdownguide.org/extended-syntax/#fenced-code-blocks) envolvendo o código em três acentos graves e seguindo os acentos iniciais com a linguagem de programação do seu trecho para obter destaque de sintaxe. Opcionalmente, você também pode escrever o nome do seu código após a linguagem de programação. + +```java HelloWorld.java +class HelloWorld { + public static void main(String[] args) { + System.out.println("Hello, World!"); + } +} +``` + +````md +```java HelloWorld.java +class HelloWorld { + public static void main(String[] args) { + System.out.println("Hello, World!"); + } +} +``` +```` + +Visite a [página de Bloco de Código](/content/components/code) para documentação mais detalhada. diff --git a/pt-BR/content/components/accordion-groups.mdx b/pt-BR/content/components/accordion-groups.mdx new file mode 100644 index 000000000..e41732165 --- /dev/null +++ b/pt-BR/content/components/accordion-groups.mdx @@ -0,0 +1,58 @@ +--- +title: Grupos de Acordeão +description: Agrupe múltiplos acordeões em uma única exibição. +icon: table-rows +--- + +Simplesmente adicione``ao redor dos seus``componentes existentes. + + + + Você pode colocar outros componentes dentro dos Acordeões. + + ```java HelloWorld.java + class HelloWorld { + public static void main(String[] args) { + System.out.println("Hello, World!"); + } + } + ``` + + + + Confira a[Acordeão](/content/components/accordions)documentação para todas as props suportadas. + + + + Confira a[Acordeão](/content/components/accordions)documentação para todas as props suportadas. + + + + + ````jsx Accordion Group Example + + + You can put other components inside Accordions. + + ```java HelloWorld.java + class HelloWorld { + public static void main(String[] args) { + System.out.println("Hello, World!"); + } + } + ``` + + + + + Check out the [Accordion](/content/components/accordions) docs for all the supported props. + + + + Check out the [Accordion](/content/components/accordions) docs for all the supported props. + + + ```` + + +`AccordionGroup`não tem nenhuma prop. diff --git a/pt-BR/content/components/accordions.mdx b/pt-BR/content/components/accordions.mdx new file mode 100644 index 000000000..cce211073 --- /dev/null +++ b/pt-BR/content/components/accordions.mdx @@ -0,0 +1,39 @@ +--- +title: Accordions +description: Um componente dropdown para alternar conteúdo +icon: square-caret-down +--- + + + Você pode colocar qualquer conteúdo aqui. Confira[AccordionGroup](/content/components/accordion-groups) se você quiser agrupar múltiplos Accordions em uma única exibição. + + + + ```jsx Accordion Example + + You can put any content in here. + + ``` + + +## Props + + + Título na prévia do Accordion. + + + + Detalhe abaixo do título na prévia do Accordion. + + + + Se o Accordion está aberto por padrão. + + + + Um [ícone Font Awesome](https://fontawesome.com/icons), [ícone Lucide](https://lucide.dev/icons), ou código SVG + + + + Um dos seguintes: "regular", "solid", "light", "thin", "sharp-solid", "duotone", ou "brands" + diff --git a/pt-BR/content/components/callouts.mdx b/pt-BR/content/components/callouts.mdx new file mode 100644 index 000000000..f49e564b2 --- /dev/null +++ b/pt-BR/content/components/callouts.mdx @@ -0,0 +1,45 @@ +--- +title: Caixas de Destaque +description: Use destaques para adicionar contexto chamativo ao seu conteúdo +icon: circle-exclamation +--- + +### Destaques de Nota + +Isto adiciona uma nota no conteúdo + +```jsx +This adds a note in the content +``` + +### Destaques de Aviso + +Isto levanta um aviso para ficar atento + +```jsx +This raises a warning to watch out for +``` + +### Destaques de Informação + +Isto chama atenção para informações importantes + +```jsx +This draws attention to important information +``` + +### Destaques de Dica + +Isto sugere uma dica útil + +```jsx +This suggests a helpful tip +``` + +### Destaques de Verificação + +Isto nos traz um status verificado + +```jsx +This brings us a checked status +``` diff --git a/pt-BR/content/components/card-groups.mdx b/pt-BR/content/components/card-groups.mdx new file mode 100644 index 000000000..c8e36bed3 --- /dev/null +++ b/pt-BR/content/components/card-groups.mdx @@ -0,0 +1,50 @@ +--- +title: Grupos de Cards +description: Mostre cards lado a lado em formato de grade +icon: rectangles-mixed +--- + +O`CardGroup`componente permite que você agrupe múltiplos`Card`componentes juntos. É mais comumente usado para colocar múltiplos cards na mesma coluna. + + + + Ninguém ama a dor por si mesma, porque é dor + + + + Lorem ipsum dolor sit amet, consectetur adipiscing elit + + + + Para chegar ao mínimo, quem de nós realiza exercício físico laborioso + + + + Exceto para obter alguma vantagem dela + + + + + ```jsx Card Group Example + + + Neque porro quisquam est qui dolorem ipsum quia dolor sit amet + + + Lorem ipsum dolor sit amet, consectetur adipiscing elit + + + Ut enim ad minim veniam, quis nostrud exercitation ullamco + + + Excepteur sint occaecat cupidatat non proident + + + ``` + + +## Props + + + O número de colunas por linha + diff --git a/pt-BR/content/components/cards.mdx b/pt-BR/content/components/cards.mdx new file mode 100644 index 000000000..7a0dc3a54 --- /dev/null +++ b/pt-BR/content/components/cards.mdx @@ -0,0 +1,71 @@ +--- +title: Cartões +description: Destaque pontos principais ou links com ícones personalizáveis +icon: rectangle +--- + + + Assim é como você usa um cartão com um ícone e um link. Clicar neste cartão + te leva à página do Grupo de Cartões. + + + + ```jsx Card Example + + This is how you use a card with an icon and a link. Clicking on this card + brings you to the Card Group page. + + ``` + + ```jsx Image Card Example + + Here is an example of a card with an image + + ``` + + +### Cartão Horizontal + +Adicione uma `horizontal` propriedade a um cartão para torná-lo exibido horizontalmente. + + + Aqui está um exemplo de um cartão horizontal + + +### Cartão com Imagem + +Adicione uma `img` propriedade a um cartão para exibir uma imagem no topo do cartão. + + + Aqui está um exemplo de um cartão com uma imagem + + +## Propriedades + + + O título do cartão + + + + Um [ícone Font Awesome](https://fontawesome.com/icons), [ícone Lucide](https://lucide.dev/icons), ou código SVG em `icon={}` + + + + Um de `regular`, `solid`, `light`, `thin`, `sharp-solid`, `duotone`, `brands` + + + + A cor do ícone como um código hexadecimal + + + + A URL para onde o clique no cartão irá navegar o usuário + + + + Torna o cartão mais compacto e horizontal + + + + A URL ou caminho local para uma imagem a ser exibida no topo do cartão + diff --git a/pt-BR/content/components/code-groups.mdx b/pt-BR/content/components/code-groups.mdx new file mode 100644 index 000000000..22691d193 --- /dev/null +++ b/pt-BR/content/components/code-groups.mdx @@ -0,0 +1,52 @@ +--- +title: Grupos de Código +description: O componente CodeGroup permite combinar blocos de código em uma exibição + separada por abas +icon: rectangle-code +--- + +Você precisará fazer [Blocos de Código](/content/components/code) e então adicionar o `` componente ao redor deles. Cada Bloco de Código deve ter um nome de arquivo porque usamos os nomes para os botões das abas. + +Veja abaixo um exemplo do resultado final. + + + ```javascript helloWorld.js + console.log("Hello World"); + ``` + + ```python hello_world.py + print('Hello World!') + ``` + + ```java HelloWorld.java + class HelloWorld { + public static void main(String[] args) { + System.out.println("Hello, World!"); + } + } + ``` + + + + ````md Code Group Example + + + ```javascript helloWorld.js + console.log("Hello World"); + ``` + + ```python hello_world.py + print('Hello World!') + ``` + + ```java HelloWorld.java + class HelloWorld { + public static void main(String[] args) { + System.out.println("Hello, World!"); + } + } + ``` + + + ```` + diff --git a/pt-BR/content/components/code.mdx b/pt-BR/content/components/code.mdx new file mode 100644 index 000000000..93fe7b607 --- /dev/null +++ b/pt-BR/content/components/code.mdx @@ -0,0 +1,199 @@ +--- +title: Blocos de Código +description: Exibir código com realce de sintaxe opcional +icon: code +--- + + + ````md Code Block Example + ```javascript Code Block Example + const hello = "world"; + ``` + ```` + + +## Bloco de Código Básico + +Use [blocos de código cercados](https://www.markdownguide.org/extended-syntax/#fenced-code-blocks) envolvendo o código com três acentos graves. + +``` +helloWorld(); +``` + +````md +``` +helloWorld(); +``` +```` + +## Realce de Sintaxe + +Coloque o nome da sua linguagem de programação após os três acentos graves para obter realce de sintaxe. + +Nós usamos [Prism](https://prismjs.com/#supported-languages) para realce de sintaxe. [Teste o Prism](https://prismjs.com/test.html#language=markup) lista todas as linguagens suportadas. + +```java +class HelloWorld { + public static void main(String[] args) { + System.out.println("Hello, World!"); + } +} +``` + +````md +```java +class HelloWorld { + public static void main(String[] args) { + System.out.println("Hello, World!"); + } +} +``` +```` + +## Nomes + +Adicione um título após a linguagem de programação para definir o nome do seu exemplo de código. O texto pode ser qualquer coisa desde que esteja em uma única linha. + +```javascript Code Block Example +const hello = "world"; +``` + +````md Code Block Example +```javascript Code Block Example +const hello = "world"; +``` +```` + +## Realce de Linhas + +Realce linhas específicas em seus blocos de código adicionando um comentário especial após o identificador da linguagem. Use chaves`{}` e especifique números de linha ou intervalos separados por vírgulas. + +```javascript Line Highlighting Example {1,3-5} +const greeting = "Hello, World!"; +function sayHello() { + console.log(greeting); +} +sayHello(); +``` + +````md +```javascript Line Highlighting Example {1,3-5} +const greeting = "Hello, World!"; +function sayHello() { + console.log(greeting); +} +sayHello(); +``` +```` + +## Expansível + +Se você tem um bloco de código longo e`[expandable]` após seu título para torná-lo fechável e expansível. + +```python library.py [expandable] +from datetime import datetime, timedelta +from typing import Dict, List, Optional +from dataclasses import dataclass + +@dataclass +class Book: + title: str + author: str + isbn: str + checked_out: bool = False + due_date: Optional[datetime] = None + +class Library: + def __init__(self): + self.books: Dict[str, Book] = {} + self.checkouts: Dict[str, List[str]] = {} # patron -> list of ISBNs + + def add_book(self, book: Book) -> None: + if book.isbn in self.books: + raise ValueError(f"Book with ISBN {book.isbn} already exists") + self.books[book.isbn] = book + + def checkout_book(self, isbn: str, patron: str, days: int = 14) -> None: + if patron not in self.checkouts: + self.checkouts[patron] = [] + + book = self.books.get(isbn) + if not book: + raise ValueError("Book not found") + + if book.checked_out: + raise ValueError("Book is already checked out") + + if len(self.checkouts[patron]) >= 3: + raise ValueError("Patron has reached checkout limit") + + book.checked_out = True + book.due_date = datetime.now() + timedelta(days=days) + self.checkouts[patron].append(isbn) + + def return_book(self, isbn: str) -> float: + book = self.books.get(isbn) + if not book or not book.checked_out: + raise ValueError("Book not found or not checked out") + + late_fee = 0.0 + if datetime.now() > book.due_date: + days_late = (datetime.now() - book.due_date).days + late_fee = days_late * 0.50 + + book.checked_out = False + book.due_date = None + + # Remove from patron's checkouts + for patron, books in self.checkouts.items(): + if isbn in books: + books.remove(isbn) + break + + return late_fee + + def search(self, query: str) -> List[Book]: + query = query.lower() + return [ + book for book in self.books.values() + if query in book.title.lower() or query in book.author.lower() + ] + +def main(): + library = Library() + + # Add some books + books = [ + Book("The Hobbit", "J.R.R. Tolkien", "978-0-261-10295-4"), + Book("1984", "George Orwell", "978-0-452-28423-4"), + ] + + for book in books: + library.add_book(book) + + # Checkout and return example + library.checkout_book("978-0-261-10295-4", "patron123") + late_fee = library.return_book("978-0-261-10295-4") + print(f"Late fee: ${late_fee:.2f}") + +if __name__ == "__main__": + main() +``` + +````md +```javascript Expandable Example [expandable] +const greeting = "Hello, World!"; +function sayHello() { + console.log(greeting); +} +sayHello(); +``` +```` + +## Grupos de Código + +Quer exibir múltiplos exemplos de código em uma única caixa de código? Confira a documentação de Grupos de Código: + + + Leia a referência para o componente Grupo de Código + diff --git a/pt-BR/content/components/expandables.mdx b/pt-BR/content/components/expandables.mdx new file mode 100644 index 000000000..35a99d881 --- /dev/null +++ b/pt-BR/content/components/expandables.mdx @@ -0,0 +1,44 @@ +--- +title: Expansíveis +description: Alterne para exibir propriedades aninhadas. +icon: caret-down +--- + + + + + O nome completo do usuário + + + + Se o usuário tem mais de 21 anos + + + + + + ```jsx Expandable Example + + + + The full name of the user + + + + Whether the user is over 21 years old + + + + ``` + + +## Props + + + O nome do objeto que você está mostrando. Usado para gerar o texto "Mostrar NOME" e + "Ocultar NOME". + + + + Defina como true para mostrar o componente aberto quando a página carregar. + diff --git a/pt-BR/content/components/frames.mdx b/pt-BR/content/components/frames.mdx new file mode 100644 index 000000000..b5a0a1131 --- /dev/null +++ b/pt-BR/content/components/frames.mdx @@ -0,0 +1,39 @@ +--- +title: Frames +description: Use o componente Frame para envolver imagens ou outros componentes em um container. +icon: frame +--- + +Frames são muito úteis quando você quer centralizar uma imagem. + + + + + +## Legendas + +Você pode adicionar contexto adicional a uma imagem usando a propriedade opcional `caption`. + + + + + +## Propriedades + + + Texto opcional de legenda para mostrar centralizado abaixo do seu componente. + + + + ```jsx Frame + + + + ``` + + ```jsx Frame with Captions + + + + ``` + diff --git a/pt-BR/content/components/icons.mdx b/pt-BR/content/components/icons.mdx new file mode 100644 index 000000000..972c95a48 --- /dev/null +++ b/pt-BR/content/components/icons.mdx @@ -0,0 +1,42 @@ +--- +title: Ícones +description: Use ícones do [Font Awesome](https://fontawesome.com/icons) ou + [Lucide](https://lucide.dev/icons) em qualquer lugar na documentação +icon: icons +--- + + + + + ```jsx Icon Example + + ``` + + +## Ícones Inline + +O ícone será colocado inline quando usado em um parágrafo. + +```markdown Inline Icon Example + The documentation you want, effortlessly +``` + + A documentação que você quer, sem esforço + +## Props + + + Um [Font Awesome](https://fontawesome.com/icons) ícone + + + + Um de `regular`, `solid`, `light`, `thin`, `sharp-solid`, `duotone`, `brands` + + + + A cor do ícone como código hexadecimal (ex., `#FF5733`) + + + + O tamanho do ícone em pixels + diff --git a/pt-BR/content/components/mermaid-diagrams.mdx b/pt-BR/content/components/mermaid-diagrams.mdx new file mode 100644 index 000000000..2d149b4c0 --- /dev/null +++ b/pt-BR/content/components/mermaid-diagrams.mdx @@ -0,0 +1,71 @@ +--- +title: Diagramas Mermaid +description: Exiba diagramas usando Mermaid +icon: diagram-project +--- + + + ````md Mermaid Flowchart Example + ```mermaid + flowchart LR + subgraph subgraph1 + direction TB + top1[top] --> bottom1[bottom] + end + subgraph subgraph2 + direction TB + top2[top] --> bottom2[bottom] + end + %% ^ These subgraphs are identical, except for the links to them: + + %% Link *to* subgraph1: subgraph1 direction is maintained + outside --> subgraph1 + %% Link *within* subgraph2: + %% subgraph2 inherits the direction of the top-level graph (LR) + outside ---> top2 + ``` + ```` + + +[Mermaid](https://mermaid.js.org/)permite que você crie diagramas visuais usando texto e código. + +```mermaid + flowchart LR + subgraph subgraph1 + direction TB + top1[top] --> bottom1[bottom] + end + subgraph subgraph2 + direction TB + top2[top] --> bottom2[bottom] + end + %% ^ These subgraphs are identical, except for the links to them: + + %% Link *to* subgraph1: subgraph1 direction is maintained + outside --> subgraph1 + %% Link *within* subgraph2: + %% subgraph2 inherits the direction of the top-level graph (LR) + outside ---> top2 +``` + +Você pode criar o seguinte usando diagramas Mermaid: + +* Fluxograma +* Diagrama de sequência +* Diagrama de classe +* Diagrama de estado +* Diagrama de relacionamento de entidade +* Jornada do usuário +* e mais + +Para uma lista completa de diagramas suportados pelo Mermaid, confira o[site](https://mermaid.js.org/). + +## Sintaxe para diagramas Mermaid + +Para criar um fluxograma, você pode escrever o fluxograma Mermaid dentro de um bloco de código Mermaid. + +````md +```mermaid +// Your mermaid code block here +``` +```` diff --git a/pt-BR/content/components/params.mdx b/pt-BR/content/components/params.mdx new file mode 100644 index 000000000..bb4196078 --- /dev/null +++ b/pt-BR/content/components/params.mdx @@ -0,0 +1,69 @@ +--- +title: Campos de Parâmetros +description: Defina parâmetros de caminho, consulta e corpo +icon: text-size +--- + +`ParamField` componentes ajudam a definir os parâmetros para suas APIs ou SDKs. Adicionar um ParamField automaticamente adicionará um [API Playground](/api-playground/overview). + + + Um exemplo de um campo de parâmetro + + + + ```jsx Path Example + + An example of a parameter field + + ``` + + ```jsx Query Example + + The filtering command used to sort through the users + + ``` + + ```jsx Body Example + + The age of the user. Cannot be less than 0 + + ``` + + +## Props + + + Se é um parâmetro de consulta, caminho, corpo ou cabeçalho seguido pelo nome + + + + Tipo esperado do valor do parâmetro + + Suporta `number`, `string`, `bool`, `object`. + + Arrays podem ser definidos usando o sufixo `[]`. Por exemplo `string[]`. + + + + Indica se o parâmetro é obrigatório + + + + Indica se o parâmetro está obsoleto + + + + Valor padrão usado pelo servidor se a requisição não fornecer um valor + + + + Valor que será usado para inicializar o playground + + + + Texto de placeholder para a entrada no playground + + + + Descrição do parâmetro (markdown habilitado) + diff --git a/pt-BR/content/components/responses.mdx b/pt-BR/content/components/responses.mdx new file mode 100644 index 000000000..ae75682ca --- /dev/null +++ b/pt-BR/content/components/responses.mdx @@ -0,0 +1,37 @@ +--- +title: Campos de Resposta +description: Exibir valores de resposta da API +icon: message +--- + +O componente `` foi projetado para definir os valores de retorno de uma API. Muitas documentações também usam `` em páginas quando você precisa listar os tipos de algo. + + + Um exemplo de campo de resposta + + + + ```jsx ResponseField Example + + A response field example + + ``` + + +## Propriedades + + + O nome do valor de resposta. + + + + Tipo esperado do valor de resposta + + + + O valor padrão. + + + + Mostrar "obrigatório" ao lado do nome do campo. + diff --git a/pt-BR/content/components/steps.mdx b/pt-BR/content/components/steps.mdx new file mode 100644 index 000000000..5357490af --- /dev/null +++ b/pt-BR/content/components/steps.mdx @@ -0,0 +1,73 @@ +--- +title: Steps +description: Sequencie conteúdo usando o componente Steps +icon: arrow-progress +--- + +Steps são a melhor maneira de exibir uma série de ações ou eventos para seus usuários. Você pode adicionar quantos passos desejar. + + + + Estas são instruções ou conteúdo que pertencem apenas ao primeiro passo. + + + + Estas são instruções ou conteúdo que pertencem apenas ao segundo passo. + + + + Estas são instruções ou conteúdo que pertencem apenas ao terceiro passo. + + + + + ```jsx Steps Example + + + These are instructions or content that only pertain to the first step. + + + These are instructions or content that only pertain to the second step. + + + These are instructions or content that only pertain to the third step. + + + ``` + + +## Props do Steps + + + Uma lista de `Step` componentes. + + + + O tamanho dos títulos dos passos. Um de `p`, `h2` e `h3`. + + +## Propriedades do Passo Individual + + + O conteúdo de um passo, seja como texto simples ou componentes. + + + + Um [ícone Font Awesome](https://fontawesome.com/icons), [ícone Lucide](https://lucide.dev/icons), ou código SVG em `icon={}` + + + + Um de `regular`, `solid`, `light`, `thin`, `sharp-solid`, `duotone`, `brands` + + + + O título é o texto principal do passo e aparece ao lado do indicador. + + + + O número do passo. + + + + O tamanho dos títulos dos passos. Um de `p`, `h2` e `h3`. + diff --git a/pt-BR/content/components/sticky-examples.mdx b/pt-BR/content/components/sticky-examples.mdx new file mode 100644 index 000000000..248e7539e --- /dev/null +++ b/pt-BR/content/components/sticky-examples.mdx @@ -0,0 +1,44 @@ +--- +title: Exemplos de Código na Barra Lateral +description: Exibe blocos de código no canto superior direito da página em dispositivos desktop +icon: sidebar-flip +--- + +O `` e `` fixam blocos de código no canto superior direito de uma página mesmo enquanto você rola. Os componentes funcionam em todas as páginas mesmo que você não use um playground de API. + +`` e `` aparecem como blocos de código normais no mobile. + +## Exemplo de Requisição + +O `` componente funciona similar ao [CodeGroup](/content/components/code-groups), mas exibe o conteúdo da requisição na barra lateral direita. Assim, você pode colocar múltiplos blocos de código dentro do ``. + +Por favor, defina um nome em cada bloco de código que você colocar dentro do RequestExample. + + + ````md RequestExample Example + + + ```bash Request + curl --request POST \ + --url https://dog-api.kinduff.com/api/facts + ``` + + + ```` + + +## Exemplo de Resposta + +O `` componente é o mesmo que o `` mas aparecerá abaixo dele. + + + ````md ResponseExample Example + + + ```json Response + { "status": "success" } + ``` + + + ```` + diff --git a/pt-BR/content/components/tabs.mdx b/pt-BR/content/components/tabs.mdx new file mode 100644 index 000000000..849f998ee --- /dev/null +++ b/pt-BR/content/components/tabs.mdx @@ -0,0 +1,43 @@ +--- +title: Abas +description: Alterne conteúdo usando o componente Tabs +icon: window-restore +--- + +Você pode adicionar qualquer número de abas. + + + + ☝️ Bem-vindo ao conteúdo que você só pode ver dentro da primeira Aba. + + + + ✌️ Aqui está o conteúdo que está apenas dentro da segunda Aba. + + + + 💪 Aqui está o conteúdo que está apenas dentro da terceira Aba. + + + + + ```jsx Tabs Example + + + ☝️ Welcome to the content that you can only see inside the first Tab. + + + ✌️ Here's content that's only inside the second Tab. + + + 💪 Here's content that's only inside the third Tab. + + + ``` + + +## Propriedades da Aba + + + O título da aba. Títulos curtos são mais fáceis de navegar. + diff --git a/pt-BR/content/components/tooltips.mdx b/pt-BR/content/components/tooltips.mdx new file mode 100644 index 000000000..f59823c7a --- /dev/null +++ b/pt-BR/content/components/tooltips.mdx @@ -0,0 +1,13 @@ +--- +title: Tooltips +description: Mostra uma definição quando você passa o mouse sobre o texto. +icon: message-lines +--- + +Passe o mouse sobre mim e veja uma dica de ferramenta em ação + + + ```jsx Tooltip Example + Hover over me + ``` + diff --git a/pt-BR/content/components/update.mdx b/pt-BR/content/components/update.mdx new file mode 100644 index 000000000..d8456b9b6 --- /dev/null +++ b/pt-BR/content/components/update.mdx @@ -0,0 +1,57 @@ +--- +title: Update +description: Acompanhe mudanças e atualizações +icon: rectangle-history +--- + +O `Update` componente é usado para acompanhar mudanças e atualizações. + + + + + + + ## Registro de Alterações + + Você pode adicionar qualquer coisa aqui, como uma captura de tela, um trecho de código ou uma lista de alterações. + + #### Recursos + + * Design responsivo + * Seção fixa para cada registro de alterações + + + + ### Como usar + + ```md + + This is how you use a changelog with a label + and a description. + + + This is how you use a changelog with a label + and a description. + + ``` + + Você pode usar múltiplos `Update` componentes para criar registros de alterações. + + + + Cada `label` cria uma âncora e também aparece no sumário à direita. + + +## Propriedades + + + Rótulo no registro de alterações, no lado esquerdo fixo. + + + + Descrição abaixo do rótulo na visualização do Registro de Alterações. + + + + Tags para o registro de alterações, serão mostradas como filtros no painel do lado direito + diff --git a/pt-BR/development.mdx b/pt-BR/development.mdx new file mode 100644 index 000000000..696f0339f --- /dev/null +++ b/pt-BR/development.mdx @@ -0,0 +1,120 @@ +--- +title: Desenvolvimento Local +description: Visualize alterações localmente para atualizar sua documentação +--- + + + **Pré-requisito**: Por favor, instale o Node.js (versão 19 ou superior) antes de prosseguir. + + +**Passo 1**: Instale o Mintlify CLI: + + + ```bash npm + npm i -g mintlify + ``` + + ```bash yarn + yarn global add mintlify + ``` + + ```bash pnpm + pnpm add -g mintlify + ``` + + +**Passo 2**: Navegue até o diretório da documentação (onde o `docs.json` arquivo está localizado) e execute o seguinte comando: + +```bash +mintlify dev +``` + +Alternativamente, se você não quiser instalar o CLI globalmente, você pode usar um script de execução disponível: + + + ```bash npm + npx mintlify dev + ``` + + ```bash yarn + yarn dlx mintlify dev + ``` + + ```bash pnpm + pnpm dlx mintlify dev + ``` + + + + O script de execução "dlx" do Yarn requer yarn versão >2. Veja [aqui](https://yarnpkg.com/cli/dlx) para mais informações. + + +Uma prévia local da sua documentação estará disponível em `http://localhost:3000`. + +### Portas Personalizadas + +Por padrão, o Mintlify usa a porta 3000. Você pode personalizar a porta usando a `--port` flag. Para executar o Mintlify na porta 3333, por exemplo, use este comando: + +```bash +mintlify dev --port 3333 +``` + +Se você tentar executar em uma porta que já está em uso, ele usará a próxima porta disponível: + +```md +Port 3000 is already in use. Trying 3001 instead. +``` + +## Versões + +Por favor, note que cada versão do CLI está associada a uma versão específica do Mintlify. Se seu site local não estiver alinhado com a versão de produção, por favor atualize o CLI: + + + ```bash npm + npm i -g mintlify@latest + ``` + + ```bash yarn + yarn global upgrade mintlify + ``` + + ```bash pnpm + pnpm up --global mintlify + ``` + + +## Validando Links + +O CLI pode ajudar na validação de links de referência feitos em sua documentação. Para identificar quaisquer links quebrados, use o seguinte comando: + +```bash +mintlify broken-links +``` + +## Implantação + +Se a implantação for bem-sucedida, você deverá ver o seguinte: + + + + + +## Formatação de Código + +Sugerimos usar extensões no seu IDE para reconhecer e formatar MDX. Se você é um usuário do VSCode, considere a [extensão MDX VSCode](https://marketplace.visualstudio.com/items?itemName=unifiedjs.vscode-mdx) para realce de sintaxe, e [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) para formatação de código. + +## Solução de Problemas + + + + Isso pode ser devido a uma versão desatualizada do node. Tente o seguinte: + + 1. Remova a versão atualmente instalada do mintlify: `npm remove -g mintlify` + 2. Atualize para Node v19 ou superior. + 3. Reinstale o mintlify: `npm install -g mintlify` + + + + Solução: Vá até a raiz do seu dispositivo e exclua a pasta \~/.mintlify. Depois, execute `mintlify dev` novamente. + + diff --git a/pt-BR/guides/auth0.mdx b/pt-BR/guides/auth0.mdx new file mode 100644 index 000000000..497989982 --- /dev/null +++ b/pt-BR/guides/auth0.mdx @@ -0,0 +1,64 @@ +--- +title: Usando Auth0 com o Handshake OAuth +description: Se Auth0 é a fonte de verdade para os dados dos seus usuários, você pode configurar o Mintlify como um aplicativo cliente OAuth para autenticar seus usuários. +--- + + + **Aviso de Segurança**: Embora fornecemos este guia para ajudá-lo a integrar o Auth0 com o Mintlify, por favor consulte sua equipe de segurança antes de implementar qualquer solução de autenticação. O Mintlify não é responsável por quaisquer problemas de segurança que possam surgir da sua implementação específica. + + +## Visão Geral + +Este guia orienta você na configuração do Auth0 como um provedor de autenticação para sua documentação Mintlify. Ao final, seus usuários poderão fazer login na sua documentação usando suas credenciais Auth0. + + + + Faça login no seu painel Auth0 e navegue até **Applications** > **Applications**. Clique no botão **Create Application**, dê um nome para sua aplicação (por exemplo, "Mintlify"), e selecione **Regular Web Applications** como o tipo de aplicação. Então clique em **Create**. + + ![Creating a new application in Auth0](/images/guides/auth0/auth0-create-application.png) + + + + Depois de criar sua aplicação, você será direcionado para a página de configurações da aplicação. Aqui, você encontrará as credenciais essenciais necessárias para a integração OAuth: + + ![Auth0 client settings page](/images/guides/auth0/auth0clientsettings.png) + + Anote as seguintes informações: + + * **Domain**: Este é o domínio do seu tenant Auth0 (por exemplo, `your-tenant.auth0.com`) + * **Client ID**: O identificador público para sua aplicação + * **Client Secret**: A chave secreta para sua aplicação (mantenha isso seguro) + + Você precisará desses valores para configurar o Mintlify na próxima etapa. + + + + Navegue até seu Painel Mintlify e vá para a seção **Settings** > **Authentication**. Selecione **OAuth** como seu método de autenticação e você verá o formulário de configuração OAuth: + + ![Mintlify OAuth client settings](/images/guides/auth0/mintlifyoauthclientsettings.png) + + Preencha o formulário com os seguintes valores: + + * **Authorization URL**: `https://YOUR_AUTH0_DOMAIN/authorize` (substitua `YOUR_AUTH0_DOMAIN` pelo seu domínio Auth0 real do passo 2) + * **Client ID**: Insira o Client ID da sua aplicação Auth0 + * **Client Secret**: Insira o Client Secret da sua aplicação Auth0 + * **Scopes**: Deixe em branco a menos que você tenha escopos personalizados definidos no Auth0 + * **Token URL**: `https://YOUR_AUTH0_DOMAIN/oauth/token` (substitua `YOUR_AUTH0_DOMAIN` pelo seu domínio Auth0 real) + + Depois de preencher esses detalhes, clique em **Save changes** para salvar sua configuração OAuth. + + + + O Mintlify irá gerar uma URL de Redirecionamento única que o Auth0 precisa reconhecer para que o fluxo OAuth funcione corretamente. + + Copie a URL de Redirecionamento das configurações de Autenticação do seu Painel Mintlify: + + ![Mintlify redirect URL](/images/guides/auth0/mintlifyredirecturl.png) + + Retorne à página de configurações da sua aplicação Auth0, role até a seção **Application URIs** e cole a URL de Redirecionamento no campo **Allowed Callback URLs**: + + ![Auth0 redirect URL configuration](/images/guides/auth0/auth0redirecturl.png) + + Clique em **Save Changes** na parte inferior da página Auth0 para aplicar esta configuração. + + diff --git a/pt-BR/image-embeds.mdx b/pt-BR/image-embeds.mdx new file mode 100644 index 000000000..e9ff66b3f --- /dev/null +++ b/pt-BR/image-embeds.mdx @@ -0,0 +1,129 @@ +--- +title: Imagens, Vídeos e Incorporações +description: Adicione imagens, vídeos e outros elementos HTML +icon: image +--- + + + + + Mintlify suporta arquivos de até 5 MB. Para usar arquivos maiores, considere um serviço de armazenamento como Cloudinary e incorpore na sua documentação usando a URL. + + +## Imagem + +### Usando Markdown + +A [sintaxe markdown](https://www.markdownguide.org/basic-syntax/#images) permite adicionar imagens usando o seguinte código + +```md +![title](/path/image.jpg) +``` + +Note que o tamanho do arquivo de imagem deve ser menor que 5MB. Caso contrário, recomendamos hospedar em um serviço como [Cloudinary](https://cloudinary.com/) ou [S3](https://aws.amazon.com/s3/). Você pode então usar essa URL e incorporar. + +### Usando Incorporações + +Para obter mais personalização com imagens, você também pode usar incorporações para adicionar imagens. + +```html + +``` + +### Desativar Zoom da Imagem + +Para desativar o zoom padrão ao clicar nas imagens, adicione a propriedade noZoom às incorporações de imagem. + +```html + +``` + +### Vinculando Imagens + +Para vincular uma imagem, por exemplo para criar um botão na sua documentação, envolva a imagem em um link com a`noZoom` propriedade. Imagens em`a` tags terão automaticamente um cursor pointer. + +```html + + + +``` + +### Modo Escuro + +Para usar imagens diferentes para modo claro e escuro, use Tailwind CSS para ocultar e mostrar imagens. + +```html + + +``` + +### Relacionados + +Para mais informações, recomendamos as seguintes seções: + + + Leia a referência para o componente Frame + + +## Vídeos + + +``` + +Para outros vídeos, use: + +```html + +``` + +Para reproduzir o vídeo automaticamente, use: + +```html + +``` + + + Como o Mintlify precisa aderir à sintaxe JSX, atributos com duas palavras precisam ser escritos em camelCase: autoPlay, playsInline. + + +## iFrames + +Carrega outra página HTML dentro do documento. + +```html + +``` + + + Embora não seja obrigatório, recomendamos adicionar os`alt` e `title` atributos às imagens para melhor SEO e acessibilidade. Saiba mais em[SEO de imagem](https://yoast.com/image-seo-alt-tag-and-title-tag-optimization/). + diff --git a/pt-BR/integrations/analytics/amplitude.mdx b/pt-BR/integrations/analytics/amplitude.mdx new file mode 100644 index 000000000..68481c067 --- /dev/null +++ b/pt-BR/integrations/analytics/amplitude.mdx @@ -0,0 +1,23 @@ +--- +title: Amplitude +--- + +Adicione o seguinte ao seu `docs.json` arquivo para enviar análises para o Amplitude. + + + ```json Analytics options in docs.json + "integrations": { + "amplitude": { + "apiKey": "required" + } + } + ``` + + ```json Example + "integrations": { + "amplitude": { + "apiKey": "76bb138bf3fbf58186XXX00000" + } + } + ``` + diff --git a/pt-BR/integrations/analytics/clearbit.mdx b/pt-BR/integrations/analytics/clearbit.mdx new file mode 100644 index 000000000..c51d7c79c --- /dev/null +++ b/pt-BR/integrations/analytics/clearbit.mdx @@ -0,0 +1,23 @@ +--- +title: Clearbit +--- + +Adicione o seguinte ao seu `docs.json` arquivo para enviar análises para o Clearbit. + + + ```json Analytics options in docs.json + "integrations": { + "clearbit": { + "publicApiKey": "required" + } + } + ``` + + ```json Example + "integrations": { + "clearbit": { + "publicApiKey": "pk_1a1882" + } + } + ``` + diff --git a/pt-BR/integrations/analytics/fathom.mdx b/pt-BR/integrations/analytics/fathom.mdx new file mode 100644 index 000000000..2139f979c --- /dev/null +++ b/pt-BR/integrations/analytics/fathom.mdx @@ -0,0 +1,25 @@ +--- +title: Fathom +--- + +Adicione o seguinte ao seu `docs.json` arquivo para enviar análises para o Fathom. + +Você pode obter o `siteId` nas configurações do seu script. + + + ```json Analytics options in docs.json + "integrations": { + "fathom": { + "siteId": "required" + } + } + ``` + + ```json Example + "integrations": { + "fathom": { + "siteId": "YSVMSDAY" + } + } + ``` + diff --git a/pt-BR/integrations/analytics/google-analytics.mdx b/pt-BR/integrations/analytics/google-analytics.mdx new file mode 100644 index 000000000..a08ab6766 --- /dev/null +++ b/pt-BR/integrations/analytics/google-analytics.mdx @@ -0,0 +1,43 @@ +--- +title: Google Analytics 4 +--- + +Você precisará gerar uma nova propriedadeGA4para usar com o Mintlify. Os dados coletados irão para o mesmo projeto que seus outros dados do Google Analytics. + +Se você estiver usando a versão antiga do Google Analytics, Universal Analytics, você ainda poderá gerar uma GA4 propriedade. GA4 os dados são um pouco diferentes dos dados do UA, mas ainda são coletados no mesmo projeto. + +## Como Conectar o GA4 ao Mintlify + +### Criar um Fluxo Web + +Você precisará criar um fluxo web para obter o ID de Medição para inserir no Mintlify. + +Clique na engrenagem no canto inferior esquerdo da tela do Google Analytics. Em seguida, clique em Fluxos de Dados. + +![](/images/ga4-web-streams.png) + +Crie um Fluxo Web e coloque a URL do seu site de documentação Mintlify como URL do fluxo. + +Seu ID de Medição se parece com `G-XXXXXXX` e aparecerá em Detalhes do Fluxo imediatamente após você criar o Fluxo Web. + +### Colocar ID de Medição no docs.json + +Adicione seu ID de Medição ao seu `docs.json` arquivo assim: + +```json docs.json +"integrations": { + "ga4": { + "measurementId": "G-XXXXXXX" + } +} +``` + +### Aguarde + +O Google Analytics leva de dois a três dias para mostrar seus dados. + +Você pode usar o [Depurador do Google Analytics](https://chrome.google.com/webstore/detail/google-analytics-debugger/jnkmfdileelhofjcijamephohjechhna?hl=en) para verificar se as análises estão ativadas corretamente. A extensão registrará no console do seu navegador toda vez que o GA4 fizer uma solicitação. + + + Links de visualização têm as análises desativadas. + diff --git a/pt-BR/integrations/analytics/google-tag-manager.mdx b/pt-BR/integrations/analytics/google-tag-manager.mdx new file mode 100644 index 000000000..5409b54fb --- /dev/null +++ b/pt-BR/integrations/analytics/google-tag-manager.mdx @@ -0,0 +1,25 @@ +--- +title: Google Tag Manager +--- + +Adicione seu ID de tag ao `docs.json` arquivo e nós injetaremos o script do Google Tag Manager em todas as suas páginas. + +Você é responsável por configurar banners de consentimento de cookies com o Google Tag Manager se você precisar deles. + + + ```json Analytics options in docs.json + "integrations": { + "gtm": { + "tagId": "required" + } + } + ``` + + ```json Example + "integrations": { + "gtm": { + "tagId": "GTM-MGBL4PW" + } + } + ``` + diff --git a/pt-BR/integrations/analytics/heap.mdx b/pt-BR/integrations/analytics/heap.mdx new file mode 100644 index 000000000..4167372d1 --- /dev/null +++ b/pt-BR/integrations/analytics/heap.mdx @@ -0,0 +1,23 @@ +--- +title: Heap +--- + +Adicione o seguinte ao seu `docs.json` arquivo para enviar análises para o Heap. + + + ```json Analytics options in docs.json + "integrations": { + "heap": { + "appId": "required" + } + } + ``` + + ```json Example + "integrations": { + "heap": { + "appId": "1234567890" + } + } + ``` + diff --git a/pt-BR/integrations/analytics/hotjar.mdx b/pt-BR/integrations/analytics/hotjar.mdx new file mode 100644 index 000000000..0890c7c66 --- /dev/null +++ b/pt-BR/integrations/analytics/hotjar.mdx @@ -0,0 +1,14 @@ +--- +title: HotJar +--- + +Adicione o seguinte ao seu `docs.json` arquivo para enviar análises para o HotJar. + +```json Analytics options in docs.json +"integrations": { + "hotjar": { + "hjid": "required", + "hjsv": "required" + } +} +``` diff --git a/pt-BR/integrations/analytics/koala.mdx b/pt-BR/integrations/analytics/koala.mdx new file mode 100644 index 000000000..e6068523e --- /dev/null +++ b/pt-BR/integrations/analytics/koala.mdx @@ -0,0 +1,23 @@ +--- +title: Koala +--- + +Adicione o seguinte ao seu `docs.json` arquivo para enviar análises para o Koala. + + + ```json Analytics options in docs.json + "integrations": { + "koala": { + "publicApiKey": "required" + } + } + ``` + + ```json Example + "integrations": { + "koala": { + "publicApiKey": "pk_1a1882" + } + } + ``` + diff --git a/pt-BR/integrations/analytics/logrocket.mdx b/pt-BR/integrations/analytics/logrocket.mdx new file mode 100644 index 000000000..779d7eae8 --- /dev/null +++ b/pt-BR/integrations/analytics/logrocket.mdx @@ -0,0 +1,13 @@ +--- +title: LogRocket +--- + +Adicione o seguinte ao seu `docs.json` arquivo para enviar análises para o LogRocket. + +```json Analytics options in docs.json +"integrations": { + "logrocket": { + "apiKey": "required" + } +} +``` diff --git a/pt-BR/integrations/analytics/mixpanel.mdx b/pt-BR/integrations/analytics/mixpanel.mdx new file mode 100644 index 000000000..c0cc066d7 --- /dev/null +++ b/pt-BR/integrations/analytics/mixpanel.mdx @@ -0,0 +1,13 @@ +--- +title: Mixpanel +--- + +Adicione o seguinte ao seu `docs.json` arquivo para enviar análises para o Mixpanel. + +```json Analytics options in docs.json +"integrations": { + "mixpanel": { + "projectToken": "required" + } +} +``` diff --git a/pt-BR/integrations/analytics/overview.mdx b/pt-BR/integrations/analytics/overview.mdx new file mode 100644 index 000000000..904ddc001 --- /dev/null +++ b/pt-BR/integrations/analytics/overview.mdx @@ -0,0 +1,612 @@ +--- +title: Integrações de Analytics +description: Integre com uma plataforma de analytics para rastrear eventos +--- + +Envie automaticamente dados sobre o engajamento da sua documentação para seu provedor de analytics terceirizado. + +## Todas as Integrações + + + + + +} + /> + + + + + + +} + /> + + + + + + + + +} + /> + + + + + + + + + + +} + /> + + + + + + + + + + +} + /> + + + + + +} + /> + + + + + +} + /> + + + + + + +} + /> + + + + + + + + + + + + + + + + + + + + + + + + + + + +} + /> + + + + + + + + + + + + + + + + + + + + + + + + + + +} + /> + + + + + + + +} + /> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +} + /> + + + + + +} + /> + + + + + + + + +} + /> + + +## Habilitando Analytics + +Configure suas chaves de analytics em `docs.json`. Você pode adicionar um número ilimitado de integrações de analytics gratuitamente. + +A sintaxe para `docs.json` está abaixo. Você só precisa incluir entradas para as plataformas que deseja conectar. + + + ```json Analytics options in docs.json + "integrations": { + "amplitude": { + "apiKey": "required" + }, + "clearbit": { + "publicApiKey": "required" + }, + "fathom": { + "siteId": "required" + }, + "ga4": { + "measurementId": "required" + }, + "gtm": { + "tagId": "required" + }, + "hotjar": { + "hjid": "required", + "hjsv": "required" + }, + "koala": { + "publicApiKey": "required" + }, + "logrocket": { + "appId": "required" + }, + "mixpanel": { + "projectToken": "required" + }, + "pirsch": { + "id": "required" + }, + "plausible": { + "domain": "required" + }, + "posthog": { + "apiKey": "required", + "apiHost": "optional" + }, + "segment": { + "key": "required" + }, + } + ``` + + ```json Google Analytics 4 Example + "integrations": { + "ga4": { + "measurementId": "G-XXXXXXX" + } + } + ``` + + +## Perguntas Frequentes + + + * `expandable_open` + + * `expandable_close` + + * `accordion_open` + + * `accordion_close` + + * `header_nav_item_click` + + * `cta_click` + + * `scroll_to_bottom` + + * `search_close` + + * `api_playground_call` + + * `search_result_click` + + * `chat_enter` + + * `chat_followup` + + * `chat_completed` + + * `code_block_copy` + + * `chat_shared` + + * `thumb_vote` + + * `powered_by_mintlify_click` + + * `ai_chat_citation_click` + + * `ai_chat_feedback_positive_click` + + * `ai_chat_feedback_negative_click` + + * `pageview` + diff --git a/pt-BR/integrations/analytics/pirsch.mdx b/pt-BR/integrations/analytics/pirsch.mdx new file mode 100644 index 000000000..1bceea9e5 --- /dev/null +++ b/pt-BR/integrations/analytics/pirsch.mdx @@ -0,0 +1,25 @@ +--- +title: Pirsch +--- + +Adicione o seguinte ao seu `docs.json` arquivo para enviar análises para o Pirsch. + +Você pode obter seu ID do site em Configurações > Desenvolvedor > Código de Identificação. + + + ```json Analytics options in docs.json + "integrations": { + "pirsch": { + "id": "required" + } + } + ``` + + ```json Example + "integrations": { + "pirsch": { + "id": "8Kw7OKxBfswOjnKGZa7P9Day8JmVYwTp" + } + } + ``` + diff --git a/pt-BR/integrations/analytics/plausible.mdx b/pt-BR/integrations/analytics/plausible.mdx new file mode 100644 index 000000000..02bb22141 --- /dev/null +++ b/pt-BR/integrations/analytics/plausible.mdx @@ -0,0 +1,28 @@ +--- +title: Plausible +--- + +Adicione o domínio do seu site ao `docs.json` para enviar análises para o Plausible. + + + Não incluir `https://` para o domínio ou servidor. + + + + ```json Analytics options in docs.json + "integrations": { + "plausible": { + "domain": "required", + "server": "optional" + } + } + ``` + + ```json Example + "integrations": { + "plausible": { + "domain": "docs.domain.com" + } + } + ``` + diff --git a/pt-BR/integrations/analytics/posthog.mdx b/pt-BR/integrations/analytics/posthog.mdx new file mode 100644 index 000000000..506f1fe0f --- /dev/null +++ b/pt-BR/integrations/analytics/posthog.mdx @@ -0,0 +1,36 @@ +--- +title: PostHog +--- + +Adicione o seguinte ao seu `docs.json` arquivo para enviar análises para o PostHog. + +Você só precisa incluir `apiHost` se você estiver auto-hospedando o PostHog. Enviamos eventos para `https://app.posthog.com` por padrão. + + + ```json Analytics options in docs.json + "integrations": { + "posthog": { + "apiKey": "YOUR_POSTHOG_PROJECT_API_KEY", + "apiHost": "optional" + } + } + ``` + + ```json Example + "integrations": { + "posthog": { + "apiKey": "phc_TXdpocbYTeZVm5VJmMzHTMrCofBQu3e0kN7HGMNGTVW" + } + } + ``` + + +
+ + + Habilitar as análises do PostHog desabilitará as análises no painel do Mintlify. + + +## Gravações de Sessão + +Você precisa adicionar a URL do seu site de documentação aos "Domínios autorizados para gravações" do Posthog antes de poder receber gravações de sessão. A opção para adicionar sua URL está nas configurações do projeto do Posthog. diff --git a/pt-BR/integrations/analytics/segment.mdx b/pt-BR/integrations/analytics/segment.mdx new file mode 100644 index 000000000..03c97c530 --- /dev/null +++ b/pt-BR/integrations/analytics/segment.mdx @@ -0,0 +1,23 @@ +--- +title: Segment +--- + +Adicione sua chave de escrita do Segment ao seu `docs.json` arquivo para enviar análises para o Segment. + + + ```json Analytics options in docs.json + "integrations": { + "segment": { + "key": "required", + } + } + ``` + + ```json Example + "integrations": { + "segment": { + "key": "nqJxiRG15Y6M594P8Sb8ESEciU3VC2" + } + } + ``` + diff --git a/pt-BR/integrations/privacy/osano.mdx b/pt-BR/integrations/privacy/osano.mdx new file mode 100644 index 000000000..425ba1075 --- /dev/null +++ b/pt-BR/integrations/privacy/osano.mdx @@ -0,0 +1,25 @@ +--- +title: Osano +--- + +Adicione o seguinte ao seu`docs.json` arquivo para adicionar o [Osano](https://www.osano.com/) gerenciador de consentimento de cookies. + + + ```json Integration options in docs.json + "integrations": { + "osano": "SOURCE" + } + ``` + + ```json Example + "integrations": { + "osano": "https://cmp.osano.com/2sUB2dqwqdkks/8dqwd-dwd86£-4a9b/osano.js" + } + ``` + + +O `SOURCE` pode ser encontrado como o valor `src` no trecho de código gerado pelo Osano. Sempre começa com `https://cmp.osano.com/`. + +```html Code snippet from Osano +