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.
Usa los símbolos # para crear encabezados de distintos niveles:
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
{#custom-id}:
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
noAnchor en encabezados HTML o React.
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.
Compatible con la mayoría del formato de Markdown para resaltar y dar estilo al texto.
Aplica estos estilos de formato a tu texto:
Puedes combinar estilos de formato:
negrita y cursiva
negrita y tachado
cursiva y tachado
Para expresiones matemáticas o notas al pie, usa etiquetas HTML:
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.
Enlaza a otras páginas de tu documentación usando rutas relativas a la raíz:
Guía rápida
Pasos
Para los recursos externos, incluye la URL completa:
Guía de Markdown
Puedes comprobar si hay enlaces rotos en tu documentación usando la CLI:
Las citas en bloque destacan información importante, citas o ejemplos dentro de tu contenido.
Citas en bloque de una sola línea
> antes del texto para crear una cita en bloque:
Este es un texto que destaca del contenido principal.
Citas en bloque de varias líneas
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. styles.latex en docs.json en tus ajustes.
Usa un solo signo de dólar, $, para expresiones matemáticas en línea:
El teorema de Pitágoras establece que (a2+b2=c2) en un triángulo rectángulo.
Usa dos signos de dólar, $$, para ecuaciones en bloque:
E=mc2
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
<br /> para forzar saltos de línea dentro de párrafos:
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.
--- o las etiquetas HTML <hr /> para agregar una línea horizontal que separe visualmente las secciones de contenido:
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.
Los comentarios al estilo HTML <!-- ... --> no son compatibles con MDX. Usa siempre {/* ... */}.
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
- 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
