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. Los fragmentos no se renderizan como páginas independientes. Debes importarlos en otros archivos.Documentation Index
Fetch the complete documentation index at: https://wiki.another-horizon.eu/llms.txt
Use this file to discover all available pages before exploring further.
Crear snippets
Importar fragmentos en páginas
- Importaciones absolutas: Comienzan con
/snippets/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.
Importar texto
- Añade al archivo de fragmento el contenido que quieras reutilizar.
snippets/my-snippet.mdx
- Importa el snippet en tu archivo de destino utilizando una ruta absoluta o relativa.
Importar variables
- Exporta variables desde un archivo de fragmento.
snippets/custom-variables.mdx
- Importa el fragmento desde tu archivo de destino y usa la variable.
destination-file.mdx
Importar fragmentos con variables
- Añade variables a tu fragmento y pásales propiedades cuando lo importes. En este ejemplo, la variable es
{word}.
snippets/my-snippet.mdx
- 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
Importar componentes de React
- Crea un fragmento con un componente JSX. Consulta Componentes de React para obtener más información.
snippets/my-jsx-snippet.jsx
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.- Importa el fragmento.
destination-file.mdx