NAME
Statocles::Store - A repository for Documents and Pages
VERSION
version 0.013
DESCRIPTION
A Statocles::Store reads and writes documents and pages.
This class handles the parsing and inflating of "document objects".
Frontmatter Document 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
ATTRIBUTES
path
The path to the directory containing the documents.
documents
All the documents currently read by this store.
METHODS
read_documents()
Read the directory path
and create the document objects inside.
read_document( path )
Read a single document in either pure YAML or combined YAML/Markdown (Frontmatter) format and return a datastructure suitable to be given to Statocles::Document.
write_document( $path, $doc )
Write a document to the store. Returns the full path to the newly-updated document.
The document is written in Frontmatter format.
write_page( $path, $html )
Write the page html
to the given path
.
AUTHOR
Doug Bell <preaction@cpan.org>
COPYRIGHT AND LICENSE
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.