Dar formato al texto

Encabezados

Los encabezados organizan tu contenido y crean anclajes de navegación. Aparecen en la tabla de contenidos y ayudan a los usuarios a explorar tu documentación.

Creación de encabezados

Usa los símbolos # para crear encabezados de distintos niveles:

## Encabezado de sección principal
### Encabezado de subsección
#### Encabezado de sub-subsección

Usa ## (H2) hasta ###### (H6) para las secciones de contenido. H1 está reservado para el título de la página establecido en tu frontmatter, así que no agregues un encabezado # de nivel superior dentro del cuerpo de la página.

Utiliza encabezados descriptivos, con palabras clave, que indiquen claramente el contenido que sigue. Esto mejora la navegación del usuario y el posicionamiento en buscadores.

IDs de encabezado personalizados

De forma predeterminada, Mintlify genera los IDs de anclaje automáticamente a partir del texto del encabezado. Puedes sobreescribir el ID generado con uno personalizado usando la sintaxis {#custom-id}:

## My section {#my-custom-anchor}
### Configuration options {#config}
##### Deep detail {#detail}

El ID personalizado reemplaza al anclaje generado automáticamente, por lo que puedes enlazar al encabezado con #my-custom-anchor o #config en lugar del texto slugificado por defecto. Esto es útil cuando deseas enlaces de anclaje estables que no cambien al actualizar el texto del encabezado, o cuando necesitas anclajes más cortos y fáciles de recordar.

Desactivar enlaces de anclaje

De forma predeterminada, los encabezados incluyen enlaces de anclaje en los que se puede hacer clic que permiten a los usuarios enlazar directamente a secciones específicas. Puedes desactivar estos enlaces de anclaje usando la prop noAnchor en encabezados HTML o React.

<h2 noAnchor>
Encabezado sin enlace de anclaje
</h2>

<Heading level={2} noAnchor>
Encabezado sin enlace de anclaje
</Heading>

Cuando se usa noAnchor, el encabezado no muestra la “píldora” de anclaje y, al hacer clic en el texto del encabezado, no se copia el enlace de anclaje al portapapeles.

Formato de texto

Compatible con la mayoría del formato de Markdown para resaltar y dar estilo al texto.

Formato básico

Aplica estos estilos de formato a tu texto:

Estilo	Sintaxis	Ejemplo	Resultado
Negrita	`text`	`nota importante`	nota importante
Cursiva	`_text_`	`_énfasis_`	énfasis
~~Tachado~~	`~text~`	`~función en desuso~`	~~función en desuso~~

Combinar formatos

Puedes combinar estilos de formato:

**_negrita y cursiva_**
**~~negrita y tachado~~**
*~~cursiva y tachado~~*

negrita y cursiva
~~negrita y tachado~~
~~cursiva y tachado~~

Superíndice y subíndice

Para expresiones matemáticas o notas al pie, usa etiquetas HTML:

Tipo	Sintaxis	Ejemplo	Resultado
Superíndice	`<sup>text</sup>`	`example<sup>2</sup>`	example²
Subíndice	`<sub>text</sub>`	`example<sub>n</sub>`	example_n

Enlaces

Los enlaces ayudan a los usuarios a navegar entre páginas y acceder a recursos externos. Usa texto de enlace descriptivo para mejorar la accesibilidad y la experiencia del usuario.

Enlaces internos

Enlaza a otras páginas de tu documentación usando rutas relativas a la raíz. Omite la extensión del archivo (.mdx o .md). Las rutas relativas y las rutas con extensión no funcionan en producción.

[Inicio rápido](/quickstart)
[Pasos](/components/steps)

Guía rápida
Pasos

Enlaces externos

Para los recursos externos, incluye la URL completa:

[Guía de Markdown](https://www.markdownguide.org/)

Guía de Markdown

Enlaces rotos

Puedes comprobar si hay enlaces rotos en tu documentación usando la CLI:

mint broken-links

Citas en bloque

Las citas en bloque destacan información importante, citas o ejemplos dentro de tu contenido.

Citas en bloque de una sola línea

Agrega > antes del texto para crear una cita en bloque:

> Este es un texto que se destaca del contenido principal.

Este es un texto que destaca del contenido principal.

Citas en bloque de varias líneas

Para citas largas o de varios párrafos:

> Este es el primer párrafo de una cita en bloque de varias líneas.
>
> Este es el segundo párrafo, separado por una línea en blanco con `>`.

Este es el primer párrafo de una cita en bloque de varias líneas. Este es el segundo párrafo, separado por una línea en blanco con >.

Usa las citas en bloque con moderación para mantener su impacto visual y su significado. Considera usar llamadas para notas, advertencias y otra información.

Expresiones matemáticas

Ofrecemos compatibilidad con LaTeX para representar expresiones y ecuaciones matemáticas. Puedes anular la detección automática configurando styling.latex en docs.json en tus ajustes.

Matemáticas en línea

Usa un solo signo de dólar, $, para expresiones matemáticas en línea:

El teorema de Pitágoras establece que $(a^2 + b^2 = c^2)$ en un triángulo rectángulo.

El teorema de Pitágoras establece que

(a^2 + b^2 = c^2)

en un triángulo rectángulo.

Ecuaciones en bloque

Usa dos signos de dólar, $$, para ecuaciones en bloque:

$$
E = mc^2
$$

E = mc^2

La compatibilidad con LaTeX requiere una sintaxis matemática correcta. Consulta la documentación de LaTeX para obtener pautas completas sobre la sintaxis.

Saltos de línea y espaciado

Controla los saltos de línea y el espaciado para mejorar la legibilidad del contenido.

Saltos de párrafo

Separe los párrafos con líneas en blanco:

Este es el primer párrafo.

Este es el segundo párrafo, separado por una línea en blanco.

Este es el primer párrafo. Este es el segundo párrafo, separado por una línea en blanco.

Saltos de línea manuales

Usa etiquetas HTML <br /> para forzar saltos de línea dentro de párrafos:

Esta línea termina aquí.<br />
Esta línea comienza en una nueva línea.

Esta línea termina aquí.
Esta línea comienza en una línea nueva.

En la mayoría de los casos, separar los párrafos con líneas en blanco ofrece mejor legibilidad que insertar saltos de línea manuales.

Líneas horizontales

Usa la sintaxis Markdown --- o las etiquetas HTML <hr /> para agregar una línea horizontal que separe visualmente las secciones de contenido:

Content preceding the rule.

<hr />

Content following the rule.

Contenido antes de la línea.

Contenido después de la línea.

Usa las líneas horizontales con moderación. En la mayoría de los casos, los encabezados proporcionan una mejor separación de contenido con el beneficio adicional de los anclajes de navegación.

Comentarios

Usa comentarios al estilo MDX para añadir notas, recordatorios o tareas pendientes en tus archivos fuente. Los comentarios no se muestran en la página publicada.

{/* Este es un comentario y no aparecerá en la documentación publicada. */}

{/*
  Los comentarios de varias líneas también funcionan.
  Útiles para tareas pendientes o notas para revisores.
*/}

Los comentarios al estilo HTML  no son compatibles con MDX. Usa siempre {/* ... */}.

Escapar caracteres especiales

MDX trata { y } como el inicio y el final de una expresión JSX, y < como el inicio de una etiqueta JSX. Cuando quieras que estos caracteres se muestren como texto literal, escápalos para que MDX no intente analizarlos.

Carácter	Cómo escaparlo
`{` y `}`	Envuelve el carácter en comillas invertidas (`{`), usa la entidad HTML (`{` para `{`, `}` para `}`) o escríbelo dentro de una expresión JSX como una cadena (`{'{'}`).
`<`	Envuelve en comillas invertidas (`<`), usa la entidad HTML `<` o escribe `{'<'}`.
`	Usa una barra invertida (\`) o envuelve un fragmento más largo en comillas invertidas dobles ( código con ` dentro ).
`\`	Usa una doble barra invertida (`\\`).

Ejemplos de escape

Usa la sintaxis `{variable}` para interpolar valores.

El marcador &#123;name&#125; se muestra como llaves literales.

En JSX, escribe {'{ key: value }'} para mostrar un objeto literal.

Dentro de los bloques de código delimitados (```), MDX no analiza las llaves, por lo que puedes escribir {variable} directamente sin escapar. El escape solo es necesario en la prosa normal y dentro de los atributos JSX.

Buenas prácticas

Organización del contenido

Usa encabezados para crear una jerarquía de contenido clara
Respeta la jerarquía correcta de encabezados (no saltes de H2 a H4)
Escribe encabezados descriptivos con palabras clave

Formato de texto

Usa la negrita para enfatizar, no para párrafos completos
Reserva la cursiva para términos, títulos o un énfasis sutil
Evita el exceso de formato que distraiga del contenido

Enlaces

Escribe un texto de enlace descriptivo en lugar de «haz clic aquí» o «leer más»
Usa rutas relativas a la raíz para los enlaces internos
Comprueba los enlaces regularmente para evitar referencias rotas

​Encabezados

​Creación de encabezados

​IDs de encabezado personalizados

​Desactivar enlaces de anclaje

​Formato de texto

​Formato básico

​Combinar formatos

​Superíndice y subíndice

​Enlaces

​Enlaces internos

​Enlaces externos

​Enlaces rotos

​Citas en bloque

​Citas en bloque de una sola línea

​Citas en bloque de varias líneas

​Expresiones matemáticas

​Matemáticas en línea

​Ecuaciones en bloque

​Saltos de línea y espaciado

​Saltos de párrafo

​Saltos de línea manuales

​Líneas horizontales

​Comentarios

​Escapar caracteres especiales

​Buenas prácticas

​Organización del contenido

​Formato de texto

​Enlaces

Encabezados

Creación de encabezados

IDs de encabezado personalizados

Desactivar enlaces de anclaje

Formato de texto

Formato básico

Combinar formatos

Superíndice y subíndice

Enlaces

Enlaces internos

Enlaces externos

Enlaces rotos

Citas en bloque

Citas en bloque de una sola línea

Citas en bloque de varias líneas

Expresiones matemáticas

Matemáticas en línea

Ecuaciones en bloque

Saltos de línea y espaciado

Saltos de párrafo

Saltos de línea manuales

Líneas horizontales

Comentarios

Escapar caracteres especiales

Buenas prácticas

Organización del contenido

Formato de texto

Enlaces