Skip to main content

​
Encabezados

Los encabezados organizan tu contenido y crean puntos de anclaje para la navegación. Aparecen en la tabla de contenidos y ayudan a los usuarios a recorrer tu documentación. Usa el símbolo # para crear encabezados de distintos niveles:
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 buscadores.

​
Desactivar los enlaces de ancla

De forma predeterminada, los encabezados incluyen enlaces de ancla en los que se puede hacer clic y que permiten a los usuarios enlazar directamente a secciones específicas. Puedes desactivar estos enlaces de ancla usando la prop noAnchor en encabezados HTML o React. De forma predeterminada, los encabezados incluyen enlaces de anclaje en los que se puede hacer clic, lo que permite a los usuarios enlazar directamente a secciones específicas. Puedes desactivar estos enlaces de anclaje usando la prop noAnchor en encabezados HTML o React.
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. 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 obsoleta~ | función obsoleta |### Combinar formatos Puedes combinar estilos de formato:
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: | 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. Usa texto de enlace descriptivo para mejorar la accesibilidad y la experiencia de usuario.### Enlaces internos Enlaza a otras páginas de tu documentación usando rutas relativas a la raíz:
Inicio rápido
Pasos
Evita los enlaces relativos como [page](../page), ya que se cargan más lentamente y no pueden optimizarse tan bien como los enlaces relativos a la raíz.

​
Enlaces externos

Para los recursos externos, incluye la URL completa:
Guía de Markdown

​
Enlaces rotos

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

​
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 Añade > antes del texto para crear una cita en bloque:
Esta es una cita que se destaca del contenido principal.

​
Citas en bloque de varias líneas

Para citas más extensas o 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 >.
Usa las citas en bloque con moderación para mantener su impacto visual y su significado. Considera usar avisos para notas, advertencias y otra información.

​
Expresiones matemáticas

Compatibilidad con LaTeX para renderizar expresiones y ecuaciones matemáticas.### Fórmulas en línea Usa un solo signo de dólar, $, para las expresiones matemáticas en línea:
El teorema de Pitágoras establece que (a2+b2=c2)(a^2 + b^2 = c^2) en un triángulo rectángulo. Usa doble signo de dólar, $$, para ecuaciones aisladas:
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 espaciados 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:
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:
Esta línea termina aquí.
Esta línea comienza en una línea nueva.
En la mayoría de los casos, los saltos de párrafo con líneas en blanco ofrecen mejor legibilidad 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 adecuada de encabezados (no saltes de H2 a H4)
  • Escribe encabezados descriptivos con palabras clave### Formato de texto
  • Usa negritas 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 textos de enlace descriptivos en lugar de “haz 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