Jamdesk Documentation logo

Encabezados

Estructura las páginas con encabezados H2 y H3 que rellenan automáticamente la tabla de contenido lateral y generan enlaces de anclaje compartibles.

Los encabezados de Markdown (##, ###) dividen tu página en secciones que los lectores pueden escanear rápidamente. Jamdesk detecta los encabezados H2 y H3 para la tabla de contenido del lado derecho y genera enlaces de anclaje que puedes compartir directamente.

Uso básico

Usa encabezados estándar de Markdown para estructurar tu contenido:

## Section Title

Content goes here...

### Subsection

More detailed content...

Los encabezados H2 y H3 aparecen en la Tabla de contenido del lado derecho para que los lectores puedan saltar entre secciones de páginas largas.

Enlaces de anclaje

Cada encabezado genera automáticamente un ID de anclaje a partir de su texto:

EncabezadoAnclaje generado
## Getting Started#getting-started
## API Reference#api-reference
### User Authentication#user-authentication

Compartir enlaces de encabezado

Pasa el cursor sobre cualquier encabezado H2 o H3 para revelar un icono de enlace. Esto facilita compartir enlaces directos a secciones específicas:

  • Haz clic en el icono de enlace para copiar la URL a tu portapapeles
  • Haz clic en el texto del encabezado para copiar la URL y navegar a esa sección

El icono de enlace aparece en un pequeño recuadro con borde a la izquierda del encabezado. Al copiar un enlace, el icono cambia brevemente de color para confirmar la acción.

En dispositivos móviles, el icono de enlace está oculto ya que no existe un estado de hover. Los encabezados siguen funcionando normalmente para la navegación.

Enlazar a encabezados

Haz referencia a secciones específicas desde otras páginas usando el anclaje:

See the [headings section](/content/mdx-basics#headings) for details.

Buenas prácticas

Empieza con H2 para las secciones principales y H3 para las subsecciones:

## Installation

### Prerequisites

### Quick Install

## Configuration

### Basic Options

### Advanced Options

Evita saltarte niveles (por ejemplo, pasar de H2 a H4 directamente).

Los encabezados cortos son más fáciles de escanear:

{/* Good */}
## Authentication

{/* Avoid */}
## How to Set Up Authentication in Your Application

Usa mayúscula únicamente en la primera palabra y en los nombres propios:

{/* Good */}
## Getting started with the API

{/* Avoid */}
## Getting Started With The API

¿Qué sigue?

Optimización SEO

Mejora el descubrimiento y los metadatos

Frontmatter

Define títulos, descripciones y campos de SEO