phpillip/phpillip

PHP Static Site Generator

Phpillip is Hugo's cousin., _(*1)

What

Phpillip is static website generator written in PHP and powered by Silex and Symfony components., _(*2)

It basically dumps your Silex application to static HTML files in a /dist folder., _(*3)

The result directory is meant to be served by an HTTP Server like apache and nginx or published to static website services like Github Pages., _(*4)

It's particularly fit for blogging, documentation and showcase., _(*5)

How

Phpillip is a Silex application., _(*6)

The build process: - Loop through all declared routes in the Application - Load content associated with the route (if any) from file - Call each route with its content in a Request - Dump the Response content in a file, _(*7)

It supports as many format as you need., _(*8)

It uses the powerful Twig engine for templating., _(*9)

Why

Phpillip is meant to be:, _(*10)

• Highly extensible
• Friendly with Symfony developers
• Clear, simple and clean

Getting started

Get your static website:, _(*11)

1. Bootstrap a Phpillip project
2. Write your content
3. Declare your routes and controllers
4. Provide templates
5. Build the static website

1. Bootstrap

To bootstrap a new Phpillip project:, _(*12)

``` bash composer create-project phpillip/phpillip-standard my_app cd my_app, <sub>(*13)</sub>

### 2. Write content

Write your content file `[my-content-slug].[format]` in `src/Resources/data/[my-content-type]/`:

__Example__ `src/Resources/data/article/why-use-phpillip.md`:

title: Why use Phpillip?

Why use Phpillip

Why not!, <sub>(*14)</sub>

### 3. Declare routes and controllers

Phpillip is a Silex application, so you can declare a route and its controller [the same way you would in Silex](http://silex.sensiolabs.org/doc/usage.html#routing):

A closure:

``` php
$this->get('/', function () { return []; })->template('index.html.twig');

Your own controller class in 'src/Controller':, <sub>(*15)</sub>

``` php $this->get('/blog', 'Controller\BlogController::index');, <sub>(*16)</sub>

A controller service (here the Phpillip content controller service):

``` php
$this->get('/blog/{post}', 'content.controller:show')->content('post');

Phpillip gives you many helpers to automate content loading for your routes., <sub>(*17)</sub>

4. Provide templates

Write the Twig templates corresponding to your routes and controllers in src/Resources/views/, <sub>(*18)</sub>

If you use the default Phpillip routes and controller, you'll need to provide:, <sub>(*19)</sub>

The list template:, <sub>(*20)</sub>

• File: [my-content-type]/index.html.twig.
• Variables: An array of contents, named [content-type]s.

``` twig {% extends 'base.html.twig' %} {% block content %} {% for article in articles %} {{ article.title }} {% endfor %} {% endblock %}, <sub>(*21)</sub>

The single content page template:

* _File:_ `[my-content-type]/show.html.twig`.
* _Variables:_ The content as an associative array, named `[content-type]`.

``` twig
{% extends 'base.html.twig' %}
{% block content %}
    {{ article.content }}
{% endblock %}

5. Build

Build the static files to /dist with the Phpillip build command:, <sub>(*22)</sub>

bin/console phpillip:build

, <sub>(*23)</sub>

You're done!, <sub>(*24)</sub>

Going further:

About Phpillip's features: - Helpers: Param Converters and other route shortcuts - Sitemap, <sub>(*25)</sub>

About content:, <sub>(*26)</sub>

• Supported formats
• Markdown
• Retrieving content
• Property handlers

About controllers:, <sub>(*27)</sub>

• Phpillip's default content controller
• Custom controller classes
• Specifying output format
• Template Resolution

About the console:, <sub>(*28)</sub>

• Phpillip's Console

Contribution

Any kind of contribution is very welcome!, <sub>(*29)</sub>

Directory structure

# Sources directory
src/
    # Your Silex Application in which your declare routes, services, ...
    Application.php

    # Your controller classes (optional)
    # This is only a recommandation, you can put controllers wherever you like
    /Controller
        MyController.php

    # Resources
    /Resources

        # Configuration files directory
        config/
            # Phpillip configuration
            config.yml

        # Content directory
        data/
            # Create a directory for each content type
            post/
                # Your 'post' contents goes here
                my-first-post.md
                a-post-in-json.json

        # Public directory
        public/
            # All public directory content will be exposed in 'dist'
            css/
                style.css

        # Views directory
        views/
            # Your twig templates
            base.html.twig
            blog/
                index.html.twig
                show.html.twig

# Destination directory
dist/
    # The static files will be dumped in here