kohkimakimoto/site-generator

A simple static site generator.

v0.1.0 2014-02-21 10:10 UTC

Requires

• michelf/php-markdown: 1.4.0
• react/http: 0.4.*
• symfony/console: 2.4.*
• symfony/filesystem: 2.4.*
• symfony/finder: 2.4.*
• symfony/process: 2.4.*
• symfony/yaml: 2.4.*

Requires (Dev)

• phpunit/phpunit: 3.*

Apache License 2.0

• Kohki Makimoto

README

A simple static site generator.

Installation

Create composer.json for installing via composer.

{
      "require": {
          "kohkimakimoto/site-generator": "dev-master"
      }
}

Run composer install command.

$ composer install

Usage

Run init command to create a basic directory structure and generator.yml.

$ php vendor/bin/site init

Created directory structure is the following

.
├── dest             # Root directory contains generated site resouces.
├── source           # Root directory contains source files of site.
│   ├── helpers      # Helpers contains PHP files are difined some user functions.
│   ├── layouts      # Layouts contains layout files.
│   ├── public       # Public is simply copied to dest directory.
│   └── views        # Views is processed to output files to dest directory.
└── generator.yml    # Main configuration file.

Run generate command to generate a static site from a source.

$ php vendor/bin/site generate

Also, you can run generate command with --watch and --server options in the development stage.

$ php vendor/bin/site generate --watch --server

If you use --server option, You can see the site at http://localhost:1234/.

If you want to clear the dest directory, you should run clear command.

$ php vendor/bin/site clear

TODO

• Supporting to generate asset files.

References

It's inspired the following products.

• sculpin
• jekyll