mtvee/quill

A static web site generator

v0.3.1 2017-12-15 20:48 UTC

Requires

• php: >=5.6 | ^7.0
• erusev/parsedown: ^1.6

Requires (Dev)

• phpunit/phpunit: 5.2.*

MIT

• Jimi

• generator
• markdown
• static
• website

README

Quill is a static website generator written in PHP. It is aimed at anyone who might want to keep a blog or documentation. The goal was to make something quick and simple to use.

Features

• uses markdown for content input
• layout is a php file so anything can go in there
• output is html via Parsedown
• PSR-4 autoloading compliant structure
• unit tested

Requirements

• PHP >= 5.6
• composer is nice

Install

The following steps presume you have composer installed somewhere the system can see it.

create a folder to store your project

$> mkdir FOLDER; cd FOLDER

install quill via composer

$> composer require mtvee/quill

or

$> git clone http://gitlab.com/mtvee/quill $> cd quill $> composer install

let quill create a skeleton project for you

$> vendor/bin/quill create

build the skeleton project in the data directory

$> vendor/bin/quill build data

the html output is in public so we can use php to run a local server and view the output in a web browser

$> php -S localhost:8080 -t public/

put http://localhost:8080 into your browser url and voila!

You can push from public to your actual web site to publish.

Next steps

• add/edit the site source files in data
• tweak the layout in data/.meta/layout.php
• add/edit your css and javascript etc in public
• push your stuff to some hosting someplace
• $$PROFIT$$

Contribute

• repo is at gitlab
• Issue tracker is at gitlab
• Documentation is at gitlab

License

MIT