La personalización se refiere a un conjunto de características que te permiten personalizar tu experiencia de documentación basándote en cierta información sobre el usuario. Hay tres características principales de la Personalización:

  • Personalizar el contenido MDX con la información del usuario, como su nombre, plan o título.

  • Prellenar claves de API en el Área de juego de API para un uso simplificado.

  • Mostrar selectivamente páginas en la navegación basándose en los grupos del usuario.

​
Cómo usar

​
Personalización del contenido MDX

Al escribir contenido, puedes usar la variable user para acceder a la información que has enviado a tus documentos. Aquí tienes un ejemplo simple:

Hola, !

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

Esta característica se vuelve aún más poderosa cuando se combina con datos personalizados sobre el usuario. Aquí tienes un ejemplo del mundo real que nos permite dar instrucciones específicas sobre cómo acceder a la función de Personalización basándonos en el plan existente del cliente:

La personalización es una característica 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>.</>
}

La información en user solo está disponible después de que un usuario haya iniciado sesión. Para usuarios no conectados, el valor de user será {}. Para evitar que la página falle para usuarios no conectados, siempre usa encadenamiento opcional en tus campos user, por ejemplo {user.org?.plan}

​
Prellenado de claves de API

Si devuelves entradas del Área de juego de API en la información del usuario, se prellenarán automáticamente en el Área de juego de API. Asegúrate de que el nombre del campo en la información del usuario coincida exactamente con el nombre en el Área de juego de API.

​
Mostrar/Ocultar páginas

Por defecto, cada página es visible para todos los usuarios. Si quieres restringir qué páginas son visibles para tus usuarios, puedes agregar un groupscampo en los metadatos de tu página. Cuando se determina qué páginas mostrar al usuario, Mintlify verificará a qué grupos pertenece el usuario. Si el usuario no está en ninguno de los grupos listados en los metadatos de la página, la página no se mostrará.

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

Aquí hay una tabla que muestra si una página se muestra para diferentes combinaciones de groups en los metadatos del Usuario y la página:

groups no en Usuariogroups: [] en Usuariogroups: ['admin'] en Usuario
groups no en metadatos✅✅✅
groups: [] en metadatos❌❌❌
groups: ['admin'] en metadatos❌❌✅

Ten en cuenta que un array vacío en los metadatos de la página se interpreta como “Ningún grupo debe ver esta página.”