Skip to content
Code on GitHub (opens in a new tab)

Documentation · Get started

Start with a starter

What an Ehundu starter is, how to create one with Composer or from GitHub, and what to change first to make it yours.

Version 0.16

A starter (in Spanish, an andamio, which literally means scaffolding) is an Ehundu project with its structure already built: the folders, the templates, the CSS and some example pages that build without warnings. It is not a code generator that leaves you half-written files, but a whole site that already works. You copy it, change the texts and the data, and from then on it is yours, with nothing tying it to the starter you came from.

There are six, for six cases: a minimal presentation site, a blog, documentation, a portfolio, a local business and a website in Spanish and Basque. Each has its own page, with screenshots, what it brings and its live demo, in the Starters section, which is the best place to see which one suits you before downloading anything.

If you hesitate between the minimal one and the local business one, the minimal is the shortest starting point, with four pages, to begin from scratch with just the essentials. The local business one is for someone with an open shop who needs opening hours, a location and legal texts.

All six build without warnings with every version of Ehundu and use no JavaScript. Their example texts are in Spanish, like the format. What follows is how to create one.

With Composer

You need PHP 8.4 or later and Composer (opens in a new tab). Create the project, which also installs the engine, and go into it:

composer create-project ehundu/andamio-blog my-blog
cd my-blog

Replace andamio-blog with andamio-minimo, andamio-documentacion, andamio-portfolio, andamio-negocio or andamio-multilingue if you prefer another one. And you can already preview it:

composer servir

Open http://127.0.0.1:8000/. Every time you save a change, reload the page: only what is needed is rebuilt.

From GitHub

Every starter is a template repository, with the “Use this template” button, which creates a repository of your own with its files. You can also download the zip. They are all in the github.com/ehundu (opens in a new tab) organisation, under the name of the package: for example, ehundu/andamio-blog. Either way, install the engine once:

composer install

The three commands

All six starters come with these Composer commands, which are Ehundu's own under another name:

composer servir      # previews it at http://127.0.0.1:8000/
composer compilar    # leaves the finished site in the salida/ folder
composer desplegar   # builds it and uploads it to the server in sitio.yml

What to change first

  1. In sitio.yml, the name and the address of the site.
  2. In datos/, your data: the name, the email, the menu.
  3. In contenido/, the texts.
  4. In publico/css/estilos.css, the colours, which are at the top as variables.

Every starter comes with a README.md with this same information and the steps to publish it. When you want to understand how it is made, Your first site builds a similar one step by step, and the guides explain the structure of a project and templates and shortcodes.