Statocles - A static site generator
version 0.010
This document is an overview of the Statocles application.
Statocles is a tool for building static HTML pages from documents.
A document is a data structure. The default store reads documents in a combined YAML and Markdown format.
Documents are formatted with a YAML document on top, and Markdown content on the bottom, like so:
--- title: This is a title author: preaction --- # This is the markdown content This is a paragraph
This is the same format that Jekyll uses. The document format is described in the Statocles::Store documentation under Frontmatter Document Format.
A Statocles::Page is rendered HTML ready to be sent to a user.
This page renders a single document.
This page renders a list of other pages (not documents).
To get started with your own Statocle site, see the setup help.
An application takes a bunch of documents and turns them into HTML pages.
A simple blogging application.
A Statocles::Site manages a bunch of applications, writing and deploying the resulting pages.
Deploying the site may involve a simple file copy, but it could also involve a Git repository, an FTP site, or a database.
A simple Git repository site.
A Statocles::Store reads and writes documents and pages. The default store reads documents in YAML and writes pages to a file, but stores could read documents as JSON, or from a Mongo database, and write pages to a database, or whereever you want!
Doug Bell <preaction@cpan.org>
This software is copyright (c) 2014 by Doug Bell.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install Statocles, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Statocles
CPAN shell
perl -MCPAN -e shell install Statocles
For more information on module installation, please visit the detailed CPAN module installation guide.