An open API service indexing awesome lists of open source software.

https://github.com/preaction/statocles

Static website CMS
https://github.com/preaction/statocles

cms perl web

Last synced: 24 days ago
JSON representation

Static website CMS

Awesome Lists containing this project

README

        

# NAME

Statocles - A static site generator

# VERSION

version 0.093

# STATUS

Coverage Status

# SYNOPSIS

# Create a new site
statocles create www.example.com

# Create a new blog post
export EDITOR=vim
statocles blog post

# Build the site
statocles build

# Test the site in a local web browser
statocles daemon

# Deploy the site
statocles deploy

# DESCRIPTION

Statocles is an application for building static web pages from a set of plain
YAML and Markdown files. It is designed to make it as simple as possible to
develop rich web content using basic text-based tools.

## FEATURES

- A simple format based on
[Markdown](http://daringfireball.net/projects/markdown/) for editing site
content.
- A command-line application for building, deploying, and editing the site.
- A simple daemon to display a test site before it goes live.
- A [blogging application](https://metacpan.org/pod/Statocles::App::Blog#FEATURES) with
- RSS and Atom syndication feeds.
- Tags to organize blog posts. Tags have their own custom feeds.
- Crosspost links to direct users to a syndicated blog.
- Post-dated blog posts to appear automatically when the date is passed.
- Customizable [themes](https://metacpan.org/pod/Statocles::Theme) using [the Mojolicious template
language](https://metacpan.org/pod/Mojo::Template#SYNTAX).
- A clean default theme using [the Skeleton CSS library](http://getskeleton.com).
- SEO-friendly features such as [sitemaps (sitemap.xml)](http://www.sitemaps.org).
- [Automatic checking for broken links](https://metacpan.org/pod/Statocles::Plugin::LinkCheck).
- [Syntax highlighting](https://metacpan.org/pod/Statocles::Plugin::Highlight) for code and configuration blocks.
- Hooks to add [your own plugins](https://metacpan.org/pod/Statocles::Plugin) and [your own custom
applications](https://metacpan.org/pod/Statocles::App).

# ATTRIBUTES

## site

The [site](https://metacpan.org/pod/Statocles::Site) we're working with.

## log

A [Mojo::Log](https://metacpan.org/pod/Mojo::Log) object for logging. Defaults to the current site's `log` attribute.

# METHODS

## run

my $exitval = $cmd->run( @argv );

Run the command given in @argv. See [statocles](https://metacpan.org/pod/statocles) for a list of commands and
options.

# GETTING STARTED

To get started with Statocles, [consult the Statocles::Help guides](https://metacpan.org/pod/Statocles::Help).

# SEE ALSO

For news and documentation, [visit the Statocles website at
http://preaction.me/statocles](http://preaction.me/statocles).

# AUTHOR

Doug Bell

# CONTRIBUTORS

- djerius
- Ed J
- Ferenc Erki
- Joel Berger
- Kent Fredric
- Konrad Bucheli
- Mohammad S Anwar
- perlancar (@netbook-zenbook-ux305)
- Roy Storey
- tadegenban
- Vladimir Lettiev
- William Lindley

# COPYRIGHT AND LICENSE

This software is copyright (c) 2016 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.