tapestry-cloud/tapestry

View on GitHub
README.md

Summary

Maintainability
Test Coverage
<h1 align="center">Tapestry</h1>
<p align="center"><em>Plates PHP Static Site Generator</em></p>

<p align="center">
  <a href="https://travis-ci.org/tapestry-cloud/tapestry"><img src="https://travis-ci.org/tapestry-cloud/tapestry.svg?branch=master" alt="Build Status"></a>
  <a href="https://codeclimate.com/github/tapestry-cloud/tapestry/coverage"><img src="https://codeclimate.com/github/tapestry-cloud/tapestry/badges/coverage.svg" alt="Test Coverage"></a>
  <a href="https://packagist.org/packages/tapestry-cloud/tapestry"><img src="https://poser.pugx.org/tapestry-cloud/tapestry/v/stable.svg" alt="Latest Stable Version"></a>
  <a href="LICENSE"><img src="https://poser.pugx.org/laravel/framework/license.svg" alt="License"></a>
</p>

## About Tapestry
Tapestry is a static site generator that uses the [plates](http://platesphp.com/) template system by the league of extraordinary packages. Tapestry aims to be fast, easy to use and easy to extend. It has been inspired by similar generators [Sculpin](https://sculpin.io/) and [Jigsaw](http://jigsaw.tighten.co/). Tapestry is designed for developers who prefer to use native PHP templates over compiled template languages such as Twig or Blade. 

### Highlights
* Native PHP templates with the use of the [plates](http://platesphp.com/) template system
* [Blog aware](https://www.tapestry.cloud/documentation/your-content/) out of the box
* Built to be extendable with [plugins](https://www.tapestry.cloud/documentation/working-examples/#plugins)

## Learning Tapestry
The [Tapestry documentation](https://www.tapestry.cloud/documentation/?utm_source=github&utm_medium=referral&utm_campaign=README) provides a thorough insight into the inner workings of Tapestry. Making it as easy as possible to get started generating your sites.

## Installing Tapestry
The recommended method for installing Tapestry is to grab the latest [zipped release here](https://github.com/carbontwelve/tapestry/releases) and unzip the contents into your `$PATH` to make it globally available from your command line.

For Windows environments a `.bat` file is included so that you do not have to type `php tapestry.phar` to run Tapestry; for it to work ensure it is kept in the same folder as the `.phar`.

For alternative methods of installing Tapestry see the [install documentation here](https://www.tapestry.cloud/documentation/installation/?utm_source=github&utm_medium=referral&utm_campaign=README).

## License
Tapestry is open sourced software licensed under the [MIT License](LICENSE).

## Not invented here
[StaticGen](https://www.staticgen.com/) has a list of other static site generators available, although to my knowledge Tapestry is the only one to use the PHPPlates template engine.