Fragmentos reutilizables

Crea fragmentos de contenido reutilizables con variables para mantener la coherencia entre páginas de documentación y reducir la duplicación en tus archivos MDX.

Uno de los principios fundamentales del desarrollo de software es DRY (Don’t Repeat Yourself), que también se aplica a la documentación. Si te encuentras repitiendo el mismo contenido en varios lugares, crea un fragmento personalizado para ese contenido. Los fragmentos incluyen contenido que puedes importar en otros archivos para reutilizarlo. Tú controlas dónde aparece el fragmento en una página. Si alguna vez necesitas actualizar el contenido, solo tendrás que editar el fragmento en lugar de cada archivo donde se use.

Actualmente, los fragmentos no son compatibles con el editor web. Para usar fragmentos, edita tus archivos MDX localmente con la CLI o envía las importaciones de fragmentos directamente a tu repositorio.

​

Cómo funcionan los snippets

Los snippets son archivos .mdx, .md o .jsx que se importan en otro archivo. Puedes colocar los archivos de snippets en cualquier parte de tu proyecto.

Cuando importas un snippet en otro archivo, el snippet solo aparece donde lo importas y no se renderiza como una página independiente. Cualquier archivo en la carpeta /snippets/ siempre se considera un snippet, incluso si no se importa en otro archivo.

​

Crear snippets

Crea un archivo con el contenido que quieras reutilizar. Los snippets pueden contener todos los tipos de contenido compatibles con Mintlify y pueden importar otros snippets.

​

Importar fragmentos en páginas

Importa fragmentos en las páginas usando una ruta absoluta o relativa.

• Importaciones absolutas: Comienzan con / para importaciones desde la raíz de tu proyecto.
• Importaciones relativas: Usa ./ o ../ para importar fragmentos en relación con la ubicación del archivo actual.

Las importaciones relativas habilitan la navegación en el IDE. Pulsa CMD y haz clic en el nombre de un fragmento en tu editor para ir directamente a su definición.

​

Importar texto

1. Añade al archivo de fragmento el contenido que quieras reutilizar.

   shared/my-snippet.mdx

   Hello world! This is my content I want to reuse across pages.
   

2. Importa el snippet en tu archivo de destino utilizando una ruta absoluta o relativa.

   Importación absoluta

   ---
   title: "Una página de ejemplo"
   description: "Esta es una página de ejemplo que importa un snippet."
   ---
   
   import MySnippet from "/shared/my-snippet.mdx";
   
   El contenido del snippet aparece debajo de esta frase.
   
   <MySnippet />
   

​

Importar variables

Haz referencia a variables de un fragmento en una página.

1. Exporta variables desde un archivo de fragmento.

   shared/custom-variables.mdx

   export const myName = "Ronan";
   
   export const myObject = { fruit: "fresas" };
   
   ;
   

2. Importa el fragmento desde tu archivo de destino y usa la variable.

   destination-file.mdx

   ---
   title: "Una página de ejemplo"
   description: "Esta es una página de ejemplo que importa un fragmento con variables."
   ---
   
   import { myName, myObject } from "/shared/custom-variables.mdx";
   
   Hello, my name is {myName} and I like {myObject.fruit}.
   

​

Importar fragmentos con variables

Usa variables para pasar datos a un fragmento cuando lo importes.

1. Añade variables a tu fragmento y pásales propiedades cuando lo importes. En este ejemplo, la variable es {word}.

   shared/my-snippet.mdx

   Mi palabra clave del día es {word}.
   

2. Importa el fragmento en tu archivo de destino con la variable. La propiedad pasada reemplaza la variable en la definición del fragmento.

   destination-file.mdx

   ---
   title: "Una página de ejemplo"
   description: "Esta es una página de ejemplo que importa un fragmento con una variable."
   ---
   
   import MySnippet from "/shared/my-snippet.mdx";
   
   <MySnippet word="bananas" />
   

​

Usar variables en bloques de código

Las variables de los fragmentos también se sustituyen dentro de los bloques de código delimitados, lo que resulta útil para documentar comandos o configuraciones que cambian según la página que los importa.

1. Añade un bloque de código a tu fragmento que haga referencia a una variable con {nombreDeVariable}. Puedes usar varias variables en el mismo bloque de código.

   shared/install-command.mdx

   Instala el paquete con el siguiente comando:
   
   ```bash
   {packageManager} install {packageName}
   ```
   

2. Importa el fragmento y pasa los valores como props. Los valores pasados reemplazan los marcadores de posición dentro del bloque de código.

   destination-file.mdx

   import InstallCommand from "/shared/install-command.mdx";
   
   <InstallCommand packageManager="npm" packageName="mintlify" />
   

Solo se sustituyen las props de tipo string dentro de los bloques de código. Los marcadores de posición que no coinciden con el nombre de una prop permanecen sin cambios, por lo que los ejemplos de código que usan {} para otros fines siguen mostrándose tal cual.

​

Importar componentes de React

1. Crea un fragmento con un componente JSX. Consulta Componentes de React para obtener más información.

   components/my-jsx-snippet.jsx

   export const MyJSXSnippet = () => {
     return (
       <div>
         <h1>¡Hola, mundo!</h1>
       </div>
     );
   };
   

Al crear fragmentos de JSX, usa la sintaxis de funciones flecha (=>) en lugar de declaraciones de función. La palabra clave function no es compatible en los fragmentos.

2. Importa el fragmento.

   destination-file.mdx

   ---
   title: "Una página de ejemplo"
   description: "Esta es una página de ejemplo que importa un fragmento con un componente de React."
   ---
   
   import { MyJSXSnippet } from "/components/my-jsx-snippet.jsx";
   
   <MyJSXSnippet />