Encabezados y texto

Aprende a dar formato al texto, crear encabezados y estilizar el contenido

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 símbolos # para crear encabezados de distintos niveles:

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

Usa encabezados descriptivos y con palabras clave que indiquen claramente el contenido que sigue. Esto mejora tanto la navegación del usuario como el posicionamiento en motores de búsqueda.

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.

HTML header example

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

Cuando se usa noAnchor, el encabezado no mostrará la insignia de anclaje y, al hacer clic en el texto del encabezado, no se copiará el enlace de anclaje al portapapeles.

Formato de texto

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

Formato básico

Aplica estos estilos de formato a tu texto:

Estilo	Sintaxis	Ejemplo	Resultado
Negrita	**texto**	**nota importante**	nota importante
Cursiva	_texto_	_énfasis_	énfasis
Tachado	~texto~	~función obsoleta~	función obsoleta

Combinando formatos

Puedes combinar estilos de formato:

**_bold and italic_**
**~~bold and strikethrough~~**
*~~italic and strikethrough~~**

negrita y cursiva
negrita y tachado
cursiva y tachado

Superíndice y subíndice

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

Tipo	Sintaxis	Ejemplo	Resultado
Superíndice	<sup>text</sup>	example<sup>2</sup>	example2
Subíndice	<sub>text</sub>	example<sub>n</sub>	examplen

Enlaces

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

Enlaces internos

Vincula otras páginas de tu documentación usando rutas relativas a la raíz:

[Quickstart](/quickstart)
[Steps](/components/steps)

Quickstart
Steps

Evita los enlaces relativos como [page](../page), ya que cargan más lento y no se pueden optimizar tan eficazmente como los enlaces relativos a la raíz.

Enlaces externos

Para 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 resaltan información importante, citas o ejemplos dentro de tu contenido.

Citas de una sola línea

Añade > antes del texto para crear una cita:

> This is a quote that stands out from the main content.

Esta es una cita que destaca del contenido principal.

Citas en bloque de varias líneas

Para citas más largas o con varios párrafos:

> This is the first paragraph of a multi-line blockquote.
>
> This is the second paragraph, separated by an empty line with `>`.

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 callouts para notas, advertencias y otra información.

Expresiones matemáticas

Compatibilidad con LaTeX para representar expresiones y ecuaciones matemáticas.

Fórmulas en línea

Usa signos de dólar simples, $, para expresiones matemáticas en línea:

The Pythagorean theorem states that $(a^2 + b^2 = c^2)$ in a right triangle.

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

Ecuaciones en bloque

Usa dobles signos de dólar, $$, para ecuaciones independientes:

$$
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 de sintaxis.

Saltos de línea y espaciado

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

Saltos de párrafo

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

This is the first paragraph.

This is the second paragraph, separated by a blank line.

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 los párrafos:

This line ends here.<br />
This line starts on a new line.

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

En la mayoría de los casos, los saltos de párrafo con líneas en blanco mejoran la legibilidad más que los saltos de línea manuales.

Buenas prácticas

Organización del contenido

• Usa encabezados para crear una jerarquía de contenido clara
• Sigue una jerarquía correcta de encabezados (no saltes de H2 a H4)
• Escribe encabezados descriptivos y 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 texto de enlace descriptivo en lugar de “hacer clic aquí” o “leer más”
• Usa rutas relativas a la raíz para los enlaces internos
• Revisa los enlaces con regularidad para evitar referencias rotas