El encabezado superior de una página de DevSite debe ser un <h1>
. El cuerpo de la página no debe contener otro <h1>
para evitar confundir a los navegadores no visuales.
La herramienta nbgenerate
convierte el contenido y las plantillas de HTML y Markdown de DevSite en notebooks de Jupyter compatibles con Colab.
Tamaños
Título 1
Encabezado 2
Encabezado 3
Encabezado 4
Encabezado 5
Encabezado 6
HTML
<h1>Heading 1</h1>
<h2>Heading 2</h2>
<h3>Heading 3</h3>
<h4>Heading 4</h4>
<h5>Heading 5</h5>
<h6>Heading 6</h6>
Markdown
# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6
Índice
En DevSite, <h2>
y <h3>
se agregan automáticamente al índice (Índice) "en esta página".
Oculta los encabezados del índice
Para evitar que se agregue un encabezado (como “Encabezado 2” y “Encabezado 3” en la sección anterior, que no aparecen en el DDC), aplica class="hide-from-toc"
.
Encabezado 2
Título 3
HTML
<h2 class="hide-from-toc">Heading 2</h2>
<h3 class="hide-from-toc">Heading 3</h3>
Markdown
## Heading 2 {:.hide-from-toc}
### Heading 3 {:.hide-from-toc}
Cómo personalizar el texto del encabezado en el índice
Si deseas que el texto del índice diffiera del encabezado real (como en esta sección), establece un atributo data-text
en el encabezado:
Encabezado 2
HTML
<h2 data-text="Custom text for the ToC">Heading 2</h2>
Markdown
## Heading 2 {: data-text='Custom text for the ToC'}
Incluye encabezados dentro de las tablas del índice
También puedes colocar un <h2>
o <h3>
dentro de un encabezado de tabla (<th>
) para forzar la tabla en el DDC. Dentro del encabezado de una tabla, <h2>
y <h3>
tienen el mismo diseño que el texto normal, por lo que los lectores no podrán distinguirlos.
Vínculos para hacer clic y copiar
En las páginas de documentación (no en las páginas "ancho completo" como la mayoría de las páginas de destino), los encabezados que no son <h1>
también tienen un botón para copiar el vínculo, que aparece solo cuando colocas el cursor sobre el encabezado.
Para inhabilitar este botón para un encabezado específico, aplica class="no-link"
al encabezado.
Encabezado 4
Encabezado 5
HTML
<h4 class="no-link">Heading 4</h4>
<h5 class="no-link">Heading 5</h5>
Markdown
## Heading 4 {:.no-link}
### Heading 5 {:.no-link}
Para forzar que el botón de vínculo aparezca en un encabezado que, de otro modo, no lo tendría (por ejemplo, un <h1>
o cualquier encabezado en una página de ancho completo), agrega class="add-link"
al encabezado.
Título 1
HTML
<h1 class="add-link">Heading 1</h1>
Markdown
# Heading 1 {:.add-link}
Encabezados numerados
Para anteponer prefijos a los encabezados <h2>
con números secuenciales para designar secciones con contenido complejo como pasos distintos en un proceso de varios pasos, agrega una clase numerada a cada encabezado.
Primer encabezado numerado
Contenido complejo compuesto por párrafos, listas, tablas, imágenes, videos y widgets.
Segundo encabezado numerado
Contenido complejo compuesto por párrafos, listas, tablas, imágenes, videos y widgets.
Tercer encabezado numerado
Contenido complejo compuesto por párrafos, listas, tablas, imágenes, videos y widgets.
HTML
<h2 class="numbered">First numbered heading</h2>
Complex content composed of paragraphs, lists, tables, images, videos, widgets.
<h2 class="numbered">Second numbered heading</h2>
Complex content composed of paragraphs, lists, tables, images, videos, widgets.
<h2 class="numbered">Third numbered heading</h2>
Complex content composed of paragraphs, lists, tables, images, videos, widgets.
Markdown
## First numbered heading {:.numbered}
Complex content composed of paragraphs, lists, tables, images, videos, widgets.
## Second numbered heading {:.numbered}
Complex content composed of paragraphs, lists, tables, images, videos, widgets.
## Third numbered heading {:.numbered}
Complex content composed of paragraphs, lists, tables, images, videos, widgets.
Subtítulos numerados
Para agregar un prefijo a los encabezados <h3>
que siguen a los encabezados <h2>
con números secuenciales, agrega una clase numerada a cada encabezado <h3>
.
HTML
<h2 class="numbered">Numbered heading</h2>
Complex content composed of paragraphs, lists, tables, images, videos, widgets.
<h3 class="numbered">Numbered subheading</h3>
Complex content composed of paragraphs, lists, tables, images, videos, widgets.
<h3 class="numbered">Numbered subheading</h3>
Complex content composed of paragraphs, lists, tables, images, videos, widgets.
<h3 class="numbered">Numbered subheading</h3>
Complex content composed of paragraphs, lists, tables, images, videos, widgets.
Markdown
## Numbered heading {:.numbered}
Complex content composed of paragraphs, lists, tables, images, videos, widgets.
### Numbered subheading {:.numbered}
Complex content composed of paragraphs, lists, tables, images, videos, widgets.
### Numbered subheading {:.numbered}
Complex content composed of paragraphs, lists, tables, images, videos, widgets.
### Numbered subheading {:.numbered}
Complex content composed of paragraphs, lists, tables, images, videos, widgets.
Encabezado numerado
Contenido complejo compuesto por párrafos, listas, tablas, imágenes, videos y widgets.
Subtítulo numerado
Contenido complejo compuesto por párrafos, listas, tablas, imágenes, videos y widgets.
Subtítulo numerado
Contenido complejo compuesto por párrafos, listas, tablas, imágenes, videos y widgets.
Subtítulo numerado
Contenido complejo compuesto por párrafos, listas, tablas, imágenes, videos y widgets.