Saltar al contenido principal

​
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
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.
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>
Cuando se usa noAnchor, el encabezado no mostrará la “píldora” 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 de Markdown para resaltar y dar estilo al texto.

​
Formato básico

Aplica estos estilos de formato a tu texto:
EstiloSintaxisEjemploResultado
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:
TipoSintaxisEjemploResultado
Superíndice<sup>text</sup>example<sup>2</sup>example2
Subíndice<sub>text</sub>example<sub>n</sub>examplen
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. Vincula otras páginas de tu documentación usando rutas relativas a la raíz: 
[Inicio rápido](/quickstart)
[Pasos](/components/steps)
Inicio rápido
Pasos
Evita los enlaces relativos como [page](../page), ya que se cargan más lentamente y no pueden optimizarse tan eficazmente como los enlaces relativos a la raíz.
Para los recursos externos, incluye la URL completa: 
[Guía de Markdown](https://www.markdownguide.org/)
Guía de Markdown Puedes comprobar si hay enlaces rotos en tu documentación usando la CLI: 
mint enlaces-rotos

​
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: 
> Esta es una cita que se destaca del contenido principal.
Esta es una cita 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 múltiples líneas.
>
> Este es el segundo párrafo, separado por una línea vacía 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

Compatibilizamos LaTeX para representar expresiones y ecuaciones matemáticas.

​
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 (a2+b2=c2)(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=mc2E = 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.

​
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
  • Usa texto de enlace descriptivo en lugar de “haz clic aquí” o “leer más”
  • Utiliza rutas relativas a la raíz para los enlaces internos
  • Revisa los enlaces con regularidad para evitar referencias rotas
⌘I