Documentation
Everything about Ehundu: a walkthrough to get started, short guides, the quick reference sheet and, in Spanish, the complete contract of the format.
Version 0.16
Ehundu builds a folder of Markdown, data and Twig templates into a plain HTML site, and it works on any hosting that runs PHP. If this is your first time, start with Your first site: in a few minutes you have something working. Then the guides explain one idea each. If you already know it, the quick reference saves you looking things up.
The format is written in Spanish on purpose: folders and fields are called contenido/, plantillas/, titulo, fecha… The guides explain what each name means, and the quick reference has them all in one table. The reference, which is the complete contract of the format, is only available in Spanish.
Get started
A working site in a few minutes, from a starter or from scratch, plus a sheet to keep everything at hand.
- Start with a starterWhat an Ehundu starter is, how to create one with Composer or from GitHub, and what to change first to make it yours.
- Your first siteInstall Ehundu, create a site with a menu and a blog, see it in the browser and publish it.
- Quick referenceThe commands, the structure of a project, the fields, the template functions and the shortcodes, on a single page, with the Spanish names explained.
Guides
One idea per page, example first.
- The structure of a projectWhat each folder holds, how it turns into addresses and what you should not version.
- Templates and shortcodesHow a page is wrapped in HTML with Twig, which variables you have at hand and how to create a shortcode of your own for Markdown.
- Several languagesA site in two or more languages with one file per language, with its selector, its menus and its dates.
- Deploying the siteHow you upload the site to a server, what Ehundu uploads and what it deletes, and what to do when you change the address.
- Shared hostingWhat the server needs, where it is best to build and the .htaccess you will use most on an Apache hosting.
- Migrating from EleventyWhat translates almost as it is, what changes name and what has no equivalent, and how to check that the new site comes out like the old one.
- Migrating from JoomlaHow to rebuild a site made with Joomla using Ehundu, keeping its addresses, and what to redirect in the .htaccess.
Reference
The complete contract, for when you need the exact detail. It is written in Spanish, like the format itself.
- The format (in Spanish)Folders, files, fields, URLs, collections, templates, Markdown, shortcodes and languages.
- The project schema (in Spanish)The file that describes a project's fields, for editors.
- The PHP library and the command (in Spanish)What a PHP program can call, and the options of the command.
- Incremental builds (in Spanish)How a build remembers what it did and redoes only what a change affects.
- Deployment (in Spanish)Folder, FTP, SFTP and S3, with their fields and secrets.
- The preview (in Spanish)The local server that rebuilds what changes.