What's on this page

• Installation
  • libvips support
• Usage
  • Build
  • Diagnostics

Library

Cecil provides a simple PHP API to build your website.

You can read the API documentation for more details.

Installation

composer require cecil/cecil

libvips support

To process images with libvips (optional), install the libvips driver in your project:

composer require intervention/image-driver-vips

Usage

Build

Build a new website with a custom configuration:

<?php

require_once 'vendor/autoload.php';

use Cecil\Builder;

$config = [
    'title'   => "My website",
    'baseurl' => 'https://domain.tld/',
];

Builder::create($config)
    ->setSourceDir(__DIR__)      // directory of the website sources (current directory by default)
    ->setDestinationDir(__DIR__) // where the output directory (`_site`) is created (source directory by default)
    ->build([]);

exec('php -S localhost:8000 -t _site'); // preview locally

The build() method accepts an array of options:

Option	Description	Default
drafts	Includes drafts.	false
dry-run	Builds without saving files.	false
page	Builds a specific page.	''
render-subset	Renders a named subset of pages.	''

These options match the build command options.

Diagnostics

You can also run doctor checks through dedicated domain services, without using CLI commands:

• Cecil\Doctor\SiteDoctor::diagnose(): configuration and environment
• Cecil\Doctor\FrontmatterDoctor::diagnose(): front matter of pages
• Cecil\Doctor\SeoDoctor::audit(): SEO of rendered pages (runs a dry-run build)
• Cecil\Doctor\LinksDoctor::audit(): internal and external links

<?php

require_once 'vendor/autoload.php';

use Cecil\Builder;
use Cecil\Doctor\SeoDoctor;
use Cecil\Doctor\SiteDoctor;

$builder = Builder::create(require 'config.php')
    ->setSourceDir(__DIR__)
    ->setDestinationDir(__DIR__);

$siteDoctor = new SiteDoctor();
$diagnosis = $siteDoctor->diagnose($builder, __DIR__, ['cecil.yml']);

$seoDoctor = new SeoDoctor();
$seoAudit = $seoDoctor->audit($builder, [
    'page' => '',
    'include_generated' => false,
]);

var_dump($diagnosis['errors'], $seoAudit['summary']);