travers

Project development and tickets are hosted at sourcehut.

This is an alpha preview. The skeleton of the project is ready, but many things still need to be done.

Travers is a microframework that allows you to build static websites of any complexity.

It has a rich modular system (middlewares) that mutates your markdown source files. After that, you can do anything you want with them inside a PHP closure (place them in folders, run a templater, etc.).

The config file is very simple. It consists of rules, each rule being a chain of middlewares and a closure as an instruction on how to template your result files.

Travers has only two hardcoded rules:

1. The source folder is flat list of markdown files, each representing the article.
2. Control over structure and other metadata is done by parsing YAML frontmatter within each article.

Requirements

• Composer
• Latest stable PHP available
• Some middlewares require node/npm

How to get started?

git clone https://github.com/hexhat/travers.git
cd travers

# Run dependency install of Travers and its middlewares
composer install

# Options are described in the help pages
./bin/travers