Gustav
Gustav is a powerful static-site gernerator written in PHP.
It provides everything you need to run a blog or any other website - From a static-site generator offering a robust templating system and a great customizability to a massive PHP API providing functions for searching the published articles and pages, getting available tags and categories, and more, as well as hooks that can be used to extend Gustav's functionality.
Moreover the project is well documented and provides lots of information on getting started and getting better with Gustav in the GitHub Wiki.
For those that just want to set up Gustav quickly, click here. Others may want to read the full documentation to get more information.
A demo of Gustav running in a production environment is avaiable on http://demo.gustav.futape.de. The source code for that website is also available on GitHub. Feel free to fork the repository and play around with the example code.
Table of contents
Features
- Fast installation and setup
- Low system requirements
- Automatic generation
- Customizable
- Massive API
- Extendable
- Easy to learn
- Well documented
A word about the master branch
This repository has two main branches, the develop branch and the master branch.
Branch management is done using Vincent Driessen's branching model, meaning that all bleeding-edge features are available on the develop branch, while the master branch contains the stable releases only. Commits on the master branch introducing changes to the public API are tagged with a version number.
Versioning is done using semantic versioning. This means that a version identifier consists of three parts, the first one being the major version number, the second one the minor version number and the third one speciying the patch number, separated by dots. Whenever a API-incompatible change is introduced, the major version is number increased. If the change is backwards-compatible to the public API, the minor version number is increased. A hotfix to the source increases the patch number.
A list of releases can be seen here. Please note, that releases with a major version number of 0 belong to the initial development phase and are not considered to be absolutely stable. However, every release since version 1.0.0 is considered to be stable.
License
The Gustav source is published under the permissive New BSD Open-Source-License.
A copy of that license is located under src/futape/gustav.
Any other content like the Gustav logo or the documentation is, if not otherwise stated, published under a Creative Commons Attribution 4.0 International License.
Support
Contributing
For information on contributing to Gustav, see CONTRIBUTING.md.
Author
| Lucas Krause (@futape) |
For a full list of contributors, click here.