Saltar al contenido HtmlpressGenerador de sitios estáticos HtmlpressGenerador de sitios estáticos

Cambiar tema

Atajos de teclado

Frontmatter

Actualizado el

Los metadatos de una página son un conjunto de claves, las mismas en ambos formatos. Una página Markdown las escribe como su frontmatter en YAML; una página HTML como su <head>, title como <title> y cualquier otra clave como <meta name="clave" content="…">. Una página es un documento completo o un fragmento, y htmlpress lee ambos de la misma forma. Todas las claves son opcionales; cuando falta una, htmlpress deduce valores predeterminados razonables a partir del archivo. 

<title>Getting started</title>
<meta name="description" content="Install and run it.">
<meta name="order" content="1">

<h1>Getting started</h1>
<p>Plain HTML, styled by the theme.</p>
 
---
title: Getting started
description: Install and run it.
order: 1
---

# Getting started

Plain Markdown, styled by the theme.

El cuerpo se convierte en el contenido de la página dentro del layout. Dale a cada página un title y un único encabezado de primer nivel.

Metadatos del artículo

Identidad y presentación de la página.

Clave Predeterminado Uso
title el primer <h1> o, si no, el nombre del archivo Da nombre a la página en la navegación y en la pestaña del navegador.
description description de htmlpress.yaml La descripción de la página para los buscadores y las vistas previas en redes sociales.
image ninguno La imagen que se muestra cuando se comparte la página, como og:image. Una URL relativa se resuelve desde el archivo fuente de la página; una local necesita site para volverse absoluta y, sin él, se omite.
head ninguno Solo Markdown: HTML sin procesar que se añade al head del layout, después del tema. Una página HTML escribe sus propios <link>, <style> o <script> en su <head>, o antes de su primer contenido, y se añaden igual.
date ninguno Cuándo se publicó la página, YYYY-MM-DD (una marca de tiempo se recorta a su fecha; cualquier otra cosa es un error). Se muestra bajo el título y ordena un blog.
author ninguno Un autor que se muestra bajo el título; una lista, o la etiqueta repetida, para varios.
keywords ninguno Etiquetas, en una lista o separadas por comas; en un blog cada una tiene una página con sus entradas.

La línea bajo el <h1> de la página también indica cuándo cambió su archivo por última vez, a partir de git log, cuando el proyecto está en un repositorio git; esa misma fecha es el <lastmod> de la página en sitemap.xml.

Ajustes de la barra lateral

Cómo aparece la página en la navegación.

Clave Predeterminado Uso
order ninguno (ordenado por ruta) Una posición de orden entera; consulta "Reglas de orden" más abajo.
layout el layout del sitio Envuelve la página en .htmlpress/layouts/<name>.html en su lugar, para una página que quiere otro marco, como una página de inicio sin la barra lateral. Un layout que no existe hace fallar la compilación; consulta Sobrescritura/Escape.
label el título Un nombre más corto para la entrada de la página en la navegación.
icon ninguno Un icono integrado antes de una entrada de primer nivel de la navegación, o del grupo de una carpeta para su página índice; las páginas dentro de una carpeta no muestran ninguno. Un nombre desconocido hace fallar la compilación.
sidebar true false deja la página fuera de la navegación y de los enlaces anterior y siguiente; se sigue compilando y es accesible por su URL.
toc true false desactiva la tabla de contenidos de la página.
breadcrumbs el breadcrumbs de la configuración false oculta la ruta de carpetas sobre el contenido; true la muestra aunque la configuración la desactive.
source-url edit seguido de la ruta de la página Adónde lleva el enlace al código fuente de la página, para una página cuyo origen está en otro sitio; source-action con valor view lo etiqueta como "Ver el código fuente" en lugar de "Editar esta página".

Reglas de orden

  • El index.html de la raíz siempre va primero.
  • Las páginas con un order de 0 o más van a continuación, en orden ascendente.
  • Les siguen las páginas sin él, por ruta.
  • Las páginas con un order negativo van al final, así que -1 fija una página al final del todo y -2 se coloca justo antes.

El orden sitúa una página entre sus hermanas: las páginas se anidan bajo el index.html de su carpeta, y una carpeta se coloca donde la sitúa el order de esa página o, si no lo tiene, donde iría su primera página.

Un order que no es un entero hace fallar la compilación. Un 404.html en la raíz es la página que un hosting muestra para una URL que no existe; queda fuera de la navegación, y un proyecto sin ella recibe un "Página no encontrada" integrado.

URL

Una página se sirve en una carpeta con el nombre de su archivo, guides/build.html en /guides/build/, e index.html en su propia carpeta: guides/index.html en /guides/, con cada nombre convertido en slug. Consulta Enlaces.

path: /start/ sirve la página en otra URL, independiente de la ruta de su archivo: una ruta que termina en / nombra esa carpeta, y una que termina en .html la página que sería ese archivo, así que /start.html también la sirve en /start/. Dos páginas en una misma URL hacen fallar la compilación.

En un sitio con languages, un archivo llamado guide.es.html, o uno con language: es, es la traducción al español de guide.html, servida en /es/guide/; consulta Traducciones.

Sobrescribir sin editar

Cada campo de esta página también se puede definir desde htmlpress.yaml, sin tocar el archivo; consulta Parches de artículos.

Ver también

Hecho con ❤ y Htmlpress

Acciones

Editar en GitHubVer como Markdown

Contenido