Download the PHP
package ehundu/ehundu without Composer
On this page you can find all versions of the php package
ehundu/ehundu. It is possible to download/install
these versions without Composer. Possible dependencies are resolved
automatically.
Vendor ehundu Package ehundu Short Description Generador de sitios estáticos en PHP, pensado para compilar también dentro de un proceso web. License
MIT Homepage https://ehundu.com
After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.
Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories.
In this case some credentials are needed to access such packages.
Please use the auth.json textarea to insert credentials, if a package is coming from a private repository.
You can look here for more information.
Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
To use Composer is sometimes complicated. Especially for beginners.
Composer needs much resources. Sometimes they are not available on a simple webspace.
If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
# Ehundu
Ehundu es un generador de sitios estáticos escrito en PHP. Toma una carpeta con
contenido en Markdown, datos en YAML y plantillas Twig, y produce un sitio web
de HTML plano que se puede alojar en cualquier servidor.
> **Estado: 1.0.** La primera versión estable. Compila sitios reales, también
> en varios idiomas, los previsualiza y los publica, saca en PDF las páginas
> que lo piden, genera una página por cada etiqueta, parte una lista larga en
> páginas con `paginar`, publica las entradas en su fecha y las retira en otra
> (`publicar` y `publicarHasta`), escribe el `srcset` de las imágenes que ya
> tienen variantes de ancho, enlaza el CSS y el JavaScript de una página como un
> fichero con la huella de su contenido en el nombre, reparte la compilación y
> la subida de un sitio grande en varias llamadas de unos segundos cada una, y
> recuerda lo que compila entre un proceso y otro para rehacer solo lo que un
> cambio afecta.
>
> Desde la 1.0 el contrato es una promesa y no un borrador. Dentro de la versión
> mayor 1 se compromete a no cambiar tres cosas, y solo a crecer: el formato del
> proyecto ([`docs/formato.md`](docs/formato.md); un proyecto lo declara con
> `formato: 1` en `sitio.yml`), la orden de consola y la lista corta de la
> biblioteca PHP que recoge [`docs/biblioteca.md`](docs/biblioteca.md). Todo lo
> demás es interno y puede cambiar en cualquier versión. Quitar algo o cambiar
> lo que significa es una versión mayor, y lo que va a dejar de valer se avisa
> durante, al menos, una versión menor antes (regla 5 del §12). El registro de
> decisiones, cada una con su motivo, está al final del contrato; el esquema que
> usa un editor tiene su documento ([`docs/esquema.md`](docs/esquema.md)) y
> `ehundu --version` dice qué versión es.
## Por qué otro generador
Los generadores de sitios estáticos más conocidos están pensados para
ejecutarse desde la línea de comandos, en el ordenador de quien desarrolla o en
un servicio de integración continua. Ehundu nace de una necesidad distinta:
poder compilar un sitio también desde un proceso web, en un alojamiento PHP
corriente, con los límites de tiempo y de recursos que eso supone.
Eso permite que una herramienta de edición guarde un cambio y publique el sitio
al momento, sin depender de servicios externos, repositorios en la nube ni
cadenas de despliegue ajenas. Y permite también lo contrario: trabajar sin
ninguna herramienta de edición, con un editor de texto y la línea de comandos,
exactamente con el mismo resultado.
## Principios
**PHP puro y pocas exigencias.** Ehundu funciona con PHP 8.4 o superior y no
necesita ejecutar programas externos ni extensiones poco habituales. Si un
alojamiento compartido ejecuta PHP, puede ejecutar Ehundu.
**Tu contenido son ficheros.** Todo lo que define un sitio vive en su carpeta:
Markdown, YAML, plantillas y archivos estáticos. Sin base de datos y sin nada
oculto que cambie el resultado (lo que el motor recuerda entre compilaciones vive
en una carpeta `.ehundu/` que se puede borrar). Una carpeta copiada a otra máquina
compila igual.
**Sin dependencia de servicios.** Ehundu se apoya en software libre que se
puede conservar y mantener, nunca en servicios cuyas condiciones pueden cambiar
de un día para otro. Publica en una carpeta, por FTP, por SFTP o en cualquier
almacenamiento compatible con S3, sin APIs propias de ningún proveedor.
**En español.** El formato del proyecto está en español: las carpetas se
llaman `contenido`, `plantillas` o `publico`, y los campos del front matter
`titulo`, `fecha` o `etiquetas`. Es una decisión deliberada. La comunidad
hispanohablante que desarrolla para la web es enorme y merece herramientas
pensadas en su idioma. Para migrar desde Eleventy o Lume se aceptan los nombres
ingleses habituales (`title`, `date`, `tags`, `layout`, `permalink`).
## Lo que Ehundu no pretende ser
**Un generador rápido a toda costa.** Ehundu prefiere funcionar en cualquier
alojamiento con PHP antes que competir en velocidad con los generadores escritos
en Go o en Rust, como Hugo. Que una compilación sea corta importa, y por eso
rehace solo lo que un cambio afecta, pero no a costa de dejar de funcionar en un
alojamiento compartido corriente.
**Un ecosistema de extensiones.** No tiene plugins ni ejecuta código propio de
cada sitio, y no es un descuido: es una promesa del contrato (regla 4 del
[§12 de `docs/formato.md`](docs/formato.md)). Un sitio es una carpeta de ficheros
y compila igual en cualquier máquina. Ehundu se apoya en unas pocas piezas de
software libre maduro, como Twig, y no pretende crecer en dependencias. Si
necesitas un plugin para cada detalle, probablemente te encaje mejor otra
herramienta.
Lo que Ehundu no hace todavía, y por qué eso no cambia el resto, está en el §13
del [contrato](docs/formato.md).
## Instalación
Hace falta PHP 8.4 o superior con la extensión `mbstring`. Para publicar por
FTP, además, la extensión `ftp`, que viene con PHP aunque a veces está
desactivada; y para FTPS o S3, `openssl`, que traen casi todas las
instalaciones.
Para generar el PDF de una página (`pdf: sí`) hace falta además dompdf, que es
PHP puro y necesita la extensión `dom`: `composer require dompdf/dompdf`. Es
opcional, y el `ehundu.phar` no lo trae.
**Un solo fichero.** Descarga `ehundu.phar` de la [página de
versiones](https://github.com/ehundu/ehundu/releases) y úsalo con PHP:
php ehundu.phar compilar mi-sitio
**Con Composer**, como orden global:
composer global require ehundu/ehundu
o dentro de un proyecto, que es como lo usaría un programa que incruste el
motor:
composer require ehundu/ehundu
La orden queda en `vendor/bin/ehundu`.
## Un primer sitio
mi-sitio/
sitio.yml
contenido/
index.md
blog/
_datos.yml
primer-articulo.md
plantillas/
pagina.twig
`sitio.yml` dice cómo se llama el sitio y dónde se publica:
Cada página es un Markdown con su front matter:
Lo que comparten todas las páginas de una carpeta va en su `_datos.yml`, así
que un artículo nuevo solo necesita título y texto:
La plantilla es Twig, con las funciones que añade Ehundu, como `coleccion()`,
y las fechas en el idioma de la página:
`ehundu compilar mi-sitio` escribe el resultado en `mi-sitio/salida/`: la
portada, `/blog/primer-articulo/` y un `sitemap.xml`.
## Las órdenes
ehundu compilar [carpeta] compila el proyecto en su carpeta salida/
ehundu servir [carpeta] lo previsualiza en el navegador y lo
recompila cuando cambia algo
ehundu desplegar [carpeta] lo compila y lo publica en el destino de
sitio.yml
`servir` rehace solo lo que afecta a cada cambio, en unas décimas de segundo,
y da siempre lo mismo que una compilación completa. `desplegar` sube lo nuevo o
cambiado y borra lo que subió Ehundu y ya no se genera; lo demás que haya en el
servidor no lo toca nunca. Con `--simular` dice qué haría sin hacerlo.
`ehundu --ayuda` enseña todas las opciones.
## Qué hace
- **Markdown** CommonMark, con tablas, notas al pie, tachado y enlaces
automáticos. Una imagen sola en su párrafo es una figura con su pie, y los
enlaces a otros dominios se abren aparte.
- **Atajos** para lo que el Markdown no tiene, sin meter lógica en el texto:
`[imagen …]`, `[video …]` (YouTube sin cookies y Vimeo sin seguimiento), `[archivo …]` (con
su tipo y su peso) y `[dato …]`. Un sitio puede añadir los suyos o cambiar
el marcado de estos con una plantilla.
- **Plantillas Twig** con colecciones por etiqueta, filtros para ordenarlas y
recorrerlas, SVG incrustados, el ancho y el alto de las imágenes, y el menú
activo.
- **Datos** globales en YAML o JSON, y por carpeta en un `_datos.yml` que
heredan todas sus páginas y subcarpetas.
- **URL** que salen de la ruta del fichero o de un patrón con los campos de la
página.
- **Una página por cada valor** de un campo, como una por etiqueta, con una
sola página que declara `agrupar`: una etiqueta nueva tiene su página sin
que nadie la escriba.
- **Listas partidas en páginas** con `paginar`: la propia página es la primera,
en su dirección, y el motor genera las demás (`/blog/pagina/2/`, o la forma
que se pida), con las entradas de cada trozo y los enlaces para moverse. Una
entrada nueva que desborde la última abre la siguiente sola.
- **Imágenes con varios anchos.** El motor no las genera, pero si otra
herramienta las deja en `publico/` (`foto-480.webp`, `foto-960.webp`…) y el
sitio las declara en `imagenes`, `variantes()`, el atajo `[imagen …]` y las
figuras del Markdown escriben el `srcset` con el ancho real de cada fichero.
- **Varios idiomas**, con un fichero por idioma en el mismo árbol
(`contacto.md`, `contacto.eu.md`): cada idioma con su prefijo en la URL, las
traducciones enlazadas entre sí para los `hreflang` y el selector de
idioma, colecciones y datos de cada idioma, y las fechas en castellano,
euskera, inglés o alemán. Traducir solo parte del sitio es lo normal, no
una excepción.
- **El CSS y el JavaScript de cada página**, reunidos e incrustados en ella o
enlazados como un fichero cuyo nombre lleva la huella de su contenido, para
que el navegador lo guarde: cada plantilla declara lo que necesita donde lo
usa. Y `version('css/estilo.css')`, para dar a cualquier otro fichero de
`publico/` una dirección que cambia cuando cambia su contenido.
- **PDF** de las páginas que lo piden con `pdf: sí`, con su propia plantilla
(`menu.pdf.twig`) y sin programas externos. El mismo proyecto da siempre los
mismos bytes, así que un PDF que no cambia no se vuelve a subir.
- **Un `sitemap.xml`**, y un feed Atom si se pide.
- **Compilación y subida repartidas en llamadas**, para un proceso web que no
tiene tiempo de compilar un sitio grande de una vez: la biblioteca las reparte
en varias llamadas con un presupuesto de segundos cada una (`avanzar`, en la
compilación incremental, y el `Desplegador`), y al terminar dan lo mismo que
una compilación completa.
- **Compilación incremental entre procesos**, para un proceso web que compila
el mismo sitio una y otra vez: lo que recuerda se guarda en el proyecto
(`.ehundu/`) y cambiar una página rehace unas pocas, en un sitio de 1.200
páginas en unos 3 s en lugar de unos 40, con el mismo resultado que una
compilación completa. También se puede repartir en llamadas de unos segundos.
- **Despliegue** a una carpeta, por FTP o FTPS, por SFTP (comprobando la
huella del servidor) o a cualquier servicio compatible con S3. Las
contraseñas van en un fichero aparte que no se versiona.
Lo que no hace, a propósito, en esta versión: generar las variantes de una
imagen (solo lee las que ya están hechas), compilar CSS o JavaScript, o
ejecutar código propio de cada sitio. El formato
está pensado para que lo que llegue después no obligue a cambiarlo, y ya
reserva lo que necesitará.
## Documentación
- [`docs/formato.md`](docs/formato.md): el formato de un proyecto, completo.
Carpetas, `sitio.yml`, datos, campos, URL, colecciones, plantillas, Markdown,
atajos, CSS y JavaScript, varios idiomas, y el registro de las decisiones
tomadas.
- [`docs/previsualizacion.md`](docs/previsualizacion.md): `ehundu servir`.
- [`docs/compilacion.md`](docs/compilacion.md): cómo decide la compilación
incremental qué rehace.
- [`docs/despliegue.md`](docs/despliegue.md): `ehundu desplegar` y cada
destino.
- [`docs/biblioteca.md`](docs/biblioteca.md): lo que se promete de la
biblioteca PHP y de la orden de consola, y qué es interno.
## Dentro de otro programa
La orden de consola es una capa fina sobre una biblioteca, y un programa puede
usar esa misma biblioteca para compilar desde un proceso web:
`Ehundu\Despliegue\Desplegador` publica de la misma forma y recibe las
contraseñas directamente, sin fichero. Los errores y los avisos están en
español y señalan el fichero y la línea, para que el programa pueda enseñarlos
tal cual. Lo que hace falta para compilar de forma incremental desde un
proceso web está explicado en [`docs/compilacion.md`](docs/compilacion.md).
## El nombre
*Ehundu* es una palabra en euskera que significa «tejer». La elección no es
casual: *web*, en inglés, es literalmente una tela, un tejido. Un generador de
sitios hace eso mismo, entrelazar contenido y plantillas hasta formar páginas.
Se pronuncia más o menos «e-ún-du».
## Licencia
Ehundu es software libre bajo licencia MIT. Consulta el fichero `LICENSE`.
La licencia cubre el código y la documentación, pero no el logotipo ni las
ilustraciones de Nidel que hay en `marca/`: sus condiciones están en
[`marca/README.md`](marca/README.md).
---
## In English
Ehundu is a static site generator written in PHP, designed to build sites both
from the command line and from within a web process on ordinary shared PHP
hosting. The current version is 1.0, the first stable one: it builds Markdown
and Twig sites, multilingual ones included, renders the pages that ask for it
as PDF (with the optional dompdf), generates one page per tag, publishes
entries on their date and withdraws them on another (`publicar` and
`publicarHasta`), drops a folder name from its pages' URLs, flags external
links to screen readers, gives Markdown headings an id (and, if asked, a
permalink) so pages can link to a section or build a table of contents, sorts
text the way a Spanish dictionary does (ignoring the opening marks ¿ and ¡),
links a page's CSS and JavaScript as a file named after a hash of its contents
so browsers can cache it for a year, converts the formatted text of a field to
HTML, inline or in blocks, with a `markdown` filter, writes the `srcset` of
images that already have width variants, splits long lists into pages,
previews them with incremental rebuilds, spreads the build and the upload of a
big site over several calls of a few seconds each (for a web process with a
time limit), remembers what it built between one process and the next so that
a change rebuilds only the pages it affects, marks its pages with a `generator`
meta tag (`generador: no` turns it off), and deploys them to a folder, FTP,
SFTP or any S3-compatible storage. It needs PHP 8.4 or later with `mbstring`
and nothing else, and ships as a single `ehundu.phar` or as the Composer
package `ehundu/ehundu`.
With 1.0 the contract stops being a draft. Within major version 1 three things
are promised and will only grow: the project format (a project declares it with
`formato: 1`), the console command, and the short part of the PHP library
listed in `docs/biblioteca.md`. Everything else is internal and may change in
any release. Removing something or changing what it means takes a new major
version, and what is about to stop working is announced for at least one minor
version first (rule 5 of the contract). `ehundu --version` prints the version.
Its project format is deliberately in Spanish (folder names, front matter
fields), as a commitment to Spanish-speaking web developers; the usual English
field names are accepted to ease migrations from Eleventy or Lume.
The documentation is in Spanish, like the format.
It does not try to be the fastest generator out there, nor an ecosystem of
extensions: it prefers to run on any PHP hosting, and it has no plugins and runs
no per-site code (rule 4 of the contract, in `docs/formato.md`).
The name *ehundu* is Basque for "to weave".
Ehundu is free software under the MIT licence. The licence covers the code
and documentation, not the logo or the Nidel illustrations in `marca/` (see
[`marca/README.md`](marca/README.md)).
Composer command for our command line client (download client)This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free.Standard composer command
The package ehundu/ehundu contains the following files
Loading the files please wait ...
Loading please wait ...
Before you can download the PHP files, the dependencies should be resolved. This can take some minutes. Please be patient.