Personalização refere-se a um conjunto de recursos que permitem personalizar sua experiência de documentação com base em algumas informações sobre o usuário. Existem três principais recursos de Personalização:

  • Personalizar conteúdo MDX com informações do usuário, como nome, plano ou título.

  • Preencher chaves de API no Playground de API para uso simplificado.

  • Mostrar páginas seletivamente na navegação com base nos grupos de um usuário.

​
Como Usar

​
Personalizando Conteúdo MDX

Ao escrever conteúdo, você pode usar a variável user para acessar as informações que você enviou para seus documentos. Aqui está um exemplo simples:

Olá, !

Hello, {user.name ?? 'reader'}!

Este recurso se torna ainda mais poderoso quando combinado com dados personalizados sobre o usuário. Aqui está um exemplo do mundo real que nos permite dar instruções específicas sobre como acessar o recurso de Personalização com base no plano existente do cliente:

Personalização é um recurso empresarial. 

Personalization is an enterprise feature. {
  user.org === undefined
    ? <>To access this feature, first create an account at the <a href="https://dashboard.mintlify.com/login">Mintlify dashboard</a>.</>
    : user.org.plan !== 'enterprise'
      ? <>You are currently on the ${user.org.plan ?? 'free'} plan. To speak to our team about upgrading, <a href="mailto:sales@mintlify.com">contact our sales team</a>.</>
      : <>To request this feature for your enterprise org, <a href="mailto:sales@mintlify.com">contact our team</a>.</>
}

As informações em user só estão disponíveis após o login do usuário. Para usuários não logados, o valor de user será {}. Para evitar que a página falhe para usuários não logados, sempre use encadeamento opcional em seus campos user, por exemplo {user.org?.plan}

​
Preenchendo Chaves de API

Se você retornar entradas do Playground de API nas informações do usuário, elas serão automaticamente preenchidas no Playground de API. Certifique-se de que o nome do campo nas informações do usuário seja exatamente igual ao nome no Playground de API.

​
Mostrando/Ocultando Páginas

Por padrão, todas as páginas são visíveis para todos os usuários. Se você quiser restringir quais páginas são visíveis para seus usuários, você pode adicionar um groupscampo nos metadados da sua página. Ao determinar quais páginas mostrar ao usuário, o Mintlify verificará a quais grupos o usuário pertence. Se o usuário não estiver em nenhum dos grupos listados nos metadados da página, a página não será exibida.

---
title: "Managing Your Users"
description: "Adding and removing users from your organization"
groups: ["admin"]
---

Aqui está uma tabela que mostra se uma página é exibida para diferentes combinações degroupsnos metadados do Usuário e da página:

groupsnão no Usuáriogroups: []no Usuáriogroups: ['admin']no Usuário
groupsnão nos metadados✅✅✅
groups: []nos metadados❌❌❌
groups: ['admin']nos metadados❌❌✅

Observe que um array vazio nos metadados da página é interpretado como “Nenhum grupo deve ver esta página.”