PHPackages                             zero-config/preacher - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Templating & Views](/categories/templating)
4. /
5. zero-config/preacher

ActiveProject[Templating & Views](/categories/templating)

zero-config/preacher
====================

Personal static website generator using GitHub Flavored Markdown, Twig and Git.

3.0.0(9y ago)15771[1 issues](https://github.com/ZeroConfig/Preacher/issues)2Apache-2.0PHPPHP ^7.0

Since Feb 5Pushed 9y ago1 watchersCompare

[ Source](https://github.com/ZeroConfig/Preacher)[ Packagist](https://packagist.org/packages/zero-config/preacher)[ Docs](https://zeroconfig.github.io/Preacher/)[ RSS](/packages/zero-config-preacher/feed)WikiDiscussions master Synced yesterday

READMEChangelogDependencies (11)Versions (8)Used By (2)

[![Build Status](https://camo.githubusercontent.com/3496f1af018c24c3e89bda88d8c4dad8db87730aa782bfefc1750f24fed5eb32/68747470733a2f2f7472617669732d63692e6f72672f5a65726f436f6e6669672f50726561636865722e7376673f6272616e63683d6d6173746572)](https://camo.githubusercontent.com/3496f1af018c24c3e89bda88d8c4dad8db87730aa782bfefc1750f24fed5eb32/68747470733a2f2f7472617669732d63692e6f72672f5a65726f436f6e6669672f50726561636865722e7376673f6272616e63683d6d6173746572)[![Latest Stable Version](https://camo.githubusercontent.com/fb5966787a5773289b6f5792986606132f6553e55ec238737f55ef39fcaf3d66/68747470733a2f2f706f7365722e707567782e6f72672f7a65726f2d636f6e6669672f70726561636865722f76657273696f6e)](https://camo.githubusercontent.com/fb5966787a5773289b6f5792986606132f6553e55ec238737f55ef39fcaf3d66/68747470733a2f2f706f7365722e707567782e6f72672f7a65726f2d636f6e6669672f70726561636865722f76657273696f6e)[![Total Downloads](https://camo.githubusercontent.com/3053d7da40f0ba183f70a12d60ced63b576d334feb0ef24fe1b6b06295149fb1/68747470733a2f2f706f7365722e707567782e6f72672f7a65726f2d636f6e6669672f70726561636865722f646f776e6c6f616473)](https://camo.githubusercontent.com/3053d7da40f0ba183f70a12d60ced63b576d334feb0ef24fe1b6b06295149fb1/68747470733a2f2f706f7365722e707567782e6f72672f7a65726f2d636f6e6669672f70726561636865722f646f776e6c6f616473)

Introduction
============

[](#introduction)

Preacher is a personal static website generator, which allows you to setup and maintain a personal website with zero configuration.

[![I always figured the word 'blog' would sound less silly as the years went by.](https://camo.githubusercontent.com/5705d6d08b8f4ef1d2ce69c4ec08731a2a381ff2b293bc51807c61581c6abc69/68747470733a2f2f696d67732e786b63642e636f6d2f636f6d6963732f737461727761746368696e672e706e67)](https://camo.githubusercontent.com/5705d6d08b8f4ef1d2ce69c4ec08731a2a381ff2b293bc51807c61581c6abc69/68747470733a2f2f696d67732e786b63642e636f6d2f636f6d6963732f737461727761746368696e672e706e67)

Fresh installation
==================

[](#fresh-installation)

To create a fresh website using Preacher, one can install it as follows:

```
composer create-project zero-config/static-website
```

When asked to remove the existing VCS, answer `Y`.

Installation on top of existing website
=======================================

[](#installation-on-top-of-existing-website)

```
composer require --dev zero-config/preacher
```

This installs the necessary files and packages. The next step is initiating a git repository, so Preacher can keep track of what needs to be published:

```
git init
```

Now all we need to do, is commit our first page and template:

```
git add index.md default.html.twig && git commit -m "My first Preacher page!"
```

To see what a basic .md page file and template can contain, have a look at Preacher's own [index.md](https://raw.githubusercontent.com/ZeroConfig/Preacher/master/index.md) page and [default.html.twig](https://github.com/ZeroConfig/Preacher/blob/master/default.html.twig)template.

By default, Preacher will look for the Twig template called `default.html.twig`. However, if a custom template is required, simply give it the same name as the source file.

E.g.: `articles/something-fancy.md` => `articles/something-fancy.html.twig`.

Generating pages
================

[](#generating-pages)

Preacher creates pages from the committed .md page files and .twig templates. It uses a single command to either generate the current directory and all its children, or one can (re)generate a single source file.

```
vendor/bin/preach []...
```

Optionally, if one wants to always generate output when a file is committed, try the following:

```
ln -s ../../vendor/bin/preach .git/hooks/post-commit
```

This will install Preacher as a post-commit hook and makes it run each time you commit one of your files.

The contents of vendor directories are skipped by interpreting the [vendor-dir composer config](https://getcomposer.org/doc/06-config.md#vendor-dir).

If one wants to force the generation of files, add the `--force` flag.

Standards
=========

[](#standards)

Preacher uses existing software with well-defined standards to create the most stable and user friendly experience at the same time.

Preacher is built with programmers in mind.

ComponentTypePackageContent parser[GitHub Flavored Markdown](https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown)[erusev/parsedown](http://parsedown.org/)Template engine[Twig 2](http://twig.sensiolabs.org/)[twig/twig](https://packagist.org/packages/twig/twig)Version control[git](https://git-scm.com/)[coyl/git](https://github.com/coyl/git)Package manager[Composer](https://getcomposer.org/)[composer/composer](https://github.com/composer/composer)Syntax highlighter[Prism](http://prismjs.com/)[prismjs](https://www.npmjs.com/package/prismjs)Documentation
=============

[](#documentation)

For full documentation and a cookbook for Preacher, go to [the Preacher homepage](https://zeroconfig.github.io/Preacher/).

###  Health Score

31

—

LowBetter than 66% of packages

Maintenance19

Infrequent updates — may be unmaintained

Popularity17

Limited adoption so far

Community12

Small or concentrated contributor base

Maturity63

Established project with proven stability

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~5 days

Total

7

Last Release

3401d ago

Major Versions

1.1.0 → 2.0.02017-02-18

2.2.0 → 3.0.02017-03-09

### Community

Maintainers

![](https://www.gravatar.com/avatar/4f105dc2b106ecb7ac1819cf18ea0276730a95d04e11918e23a2bef60efc3bbd?d=identicon)[janmarten\_jongerius](/maintainers/janmarten_jongerius)

---

Top Contributors

[![vssr](https://avatars.githubusercontent.com/u/912625?v=4)](https://github.com/vssr "vssr (4 commits)")

---

Tags

phptwigmarkdownstaticwebsitegitblogprism

###  Code Quality

TestsPHPUnit

Static AnalysisPHPStan

Code StylePHP\_CodeSniffer

Type Coverage Yes

### Embed Badge

![Health badge](/badges/zero-config-preacher/health.svg)

```
[![Health](https://phpackages.com/badges/zero-config-preacher/health.svg)](https://phpackages.com/packages/zero-config-preacher)
```

###  Alternatives

[picocms/pico

Pico is a flat file CMS, this means there is no administration backend and database to deal with. You simply create .md files in the "content" folder and that becomes a page.

3.9k38.0k11](/packages/picocms-pico)[symfony/ux-twig-component

Twig components for Symfony

22018.6M337](/packages/symfony-ux-twig-component)[twig/markdown-extra

A Twig extension for Markdown

12116.2M127](/packages/twig-markdown-extra)[symfony/ux-live-component

Live components for Symfony

1647.0M124](/packages/symfony-ux-live-component)[october/rain

October Rain Library

1601.7M80](/packages/october-rain)[shopware/core

Shopware platform is the core for all Shopware ecommerce products.

585.6M556](/packages/shopware-core)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)